~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

<para>The [NodeAttribute] custom attribute can be used to specify fields that have to be initialized from node attributes. By default, a field is will get its value from an attribute with the same name, although it is possible to specify a different name by setting the NodeAttribute.Name property. NodeAttribute also has a Required property for specifying if an attribute is mandatory or not.

</para>

public class FileTemplateNode: ExtensionNode

{

// Will match elements like <FileTemplate resource-name="blah" />

// The true parameter specifies that the attribute is required

[NodeAttribute ("resource-name", true, Description="Name of the resource where the template is stored.")]

string resource;

[NodeAttribute]

string name;

public string Name {

get { return name != null ? name : Id; }

}

public virtual string GetContent ()

{

using (StreamReader sr = new StreamReader(Addin.GetResource (resource))) {

return sr.ReadToEnd ();

}

} </code>

</example>

<para>

If an <see cref="T:Mono.Addins.ExtensionNode" /> subclass overrides the <see cref="M:Mono.Addins.ExtensionNode.Read" /> method to provide a custom node deserialization implementation, [NodeAttribute] attributes applied to fileds will be ignored. In this case, this attribute can also be applied at class level to provide documentation about the supported attributes. For example:

</para>

[NodeAttribute ("name", typeof(string), false, Description="Name of the template.")]

[NodeAttribute ("resource-name", typeof(string), true, Description="Name of the resource where the template is stored.")]

public class FileTemplateNode: ExtensionNode

{

string resource;

string name;

public string Name {

get { return name != null ? name : Id; }

}

public virtual string GetContent ()

{

using (StreamReader sr = new StreamReader(Addin.GetResource (resource))) {

return sr.ReadToEnd ();

}

protected override void Read (NodeElement elem)

{

resource = elem.GetAttribute ("resource-name");

name = elem.GetAttribute ("name");

}

</code>

</example>

</remarks>

</Docs>

<MemberType>Constructor</MemberType>

<Docs>

<summary>Initializes a new instance.</summary>

<remarks>It takes the field name and type as name and type of the attribute.</remarks>

</Docs>

</AssemblyInfo>

</Member>

<MemberType>Constructor</MemberType>

</Parameters>

<Docs>

<param name="name">XML name of the attribute.</param>

<summary>Initializes a new instance.</summary>

</Docs>

100

101

</AssemblyInfo>

102

</Member>

103

104

105

<MemberType>Constructor</MemberType>

106

107

108

109

</Parameters>

110

<Docs>

111

<param name="name">XML name of the attribute.</param>

112

<param name="required">Indicates whether the attribute is required or not.</param>

113

<summary>Initializes a new instance.</summary>

114

115

</Docs>

116

117

118

</AssemblyInfo>

119

</Member>

120

121

122

<MemberType>Constructor</MemberType>

123

124

125

</AssemblyInfo>

126

127

128

129

</Parameters>

130

<Docs>

131

<param name="name">To be added.</param>

132

<param name="description">To be added.</param>

133

<summary>To be added.</summary>

134

<remarks>To be added.</remarks>

135

</Docs>

136

</Member>

137

138

139

<MemberType>Constructor</MemberType>

140

141

142

143

</Parameters>

144

<Docs>

145

<param name="name">XML name of the attribute.</param>

146

<param name="type">Type of the extension node attribute.</param>

147

<summary>Initializes a new instance.</summary>

148

<remarks>This constructor can only be used when applying [NodeAttribute] at class level.</remarks>

149

</Docs>

150

151

152

</AssemblyInfo>

153

</Member>

154

155

156

<MemberType>Constructor</MemberType>

157

158

159

</AssemblyInfo>

160

161

162

163

164

</Parameters>

165

<Docs>

166

<param name="name">To be added.</param>

167

<param name="required">To be added.</param>

168

<param name="description">To be added.</param>

169

<summary>To be added.</summary>

170

<remarks>To be added.</remarks>

171

</Docs>

172

</Member>

173

174

175

<MemberType>Constructor</MemberType>

176

177

178

179

180

</Parameters>

181

<Docs>

182

<param name="name">XML name of the attribute.</param>

183

<param name="type">Type of the extension node attribute.</param>

184

<param name="required">Indicates whether the attribute is required or not.</param>

185

<summary>Initializes a new instance.</summary>

186

<remarks>This constructor can only be used when applying [NodeAttribute] at class level.</remarks>

187

</Docs>

188

189

190

</AssemblyInfo>

191

</Member>

192

193

194

<MemberType>Constructor</MemberType>

195

196

197

</AssemblyInfo>

198

199

200

201

202

</Parameters>

203

<Docs>

204

<param name="name">To be added.</param>

205

<param name="type">To be added.</param>

206

<param name="description">To be added.</param>

207

<summary>To be added.</summary>

208

<remarks>To be added.</remarks>

209

</Docs>

210

</Member>

211

212

213

<MemberType>Constructor</MemberType>

214

215

216

</AssemblyInfo>

217

218

219

220

221

222

</Parameters>

223

<Docs>

224

<param name="name">To be added.</param>

225

<param name="type">To be added.</param>

226

<param name="required">To be added.</param>

227

<param name="description">To be added.</param>

228

<summary>To be added.</summary>

229

<remarks>To be added.</remarks>

230

</Docs>

231

</Member>

232

233

234

<MemberType>Property</MemberType>

235

236

<ReturnType>System.String</ReturnType>

237

</ReturnValue>

238

<Docs>

239

<summary>Description of the attribute.</summary>

240

<value>Description of the attribute.</value>

241

<remarks>To be used in the extension point documentation.</remarks>

242

</Docs>

243

244

245

</AssemblyInfo>

246

</Member>

247

248

249

<MemberType>Property</MemberType>

250

251

252

</AssemblyInfo>

253

254

<ReturnType>System.Boolean</ReturnType>

255

</ReturnValue>

256

<Docs>

257

<summary>To be added.</summary>

258

<value>To be added.</value>

259

<remarks>To be added.</remarks>

260

</Docs>

261

</Member>

262

263

264

<MemberType>Property</MemberType>

265

266

<ReturnType>System.String</ReturnType>

267

</ReturnValue>

268

<Docs>

269

<summary>XML name of the attribute.</summary>

270

<value>XML name of the attribute.</value>

271

272

<para>

273

If the name is not specified, the field name to which the [NodeAttribute] is applied will be used as name.

274

</para>

275

<para>

276

Providing a name is mandatory when applying [NodeAttribute] at class level.

277

</para>

278

</remarks>

279

</Docs>

280

281

282

</AssemblyInfo>

283

</Member>

284

285

286

<MemberType>Property</MemberType>

287

288

<ReturnType>System.Boolean</ReturnType>

289

</ReturnValue>

290

<Docs>

291

<summary>Indicates whether the attribute is required or not.</summary>

292

<value>'true' if the attribute is required.</value>

293

294

</Docs>

295

296

297

</AssemblyInfo>

298

</Member>

299

300

301

<MemberType>Property</MemberType>

302

303

<ReturnType>System.Type</ReturnType>

304

</ReturnValue>

305

<Docs>

306

<summary>Type of the extension node attribute.</summary>

307

308

<remarks>To be used only when applying [NodeAttribute] at class level. Not required when it is applied to a field, since the attribute type will be the type of the field.</remarks>

309

</Docs>

310

311

312

</AssemblyInfo>

313

</Member>

314

</Members>

315

316

317

<AttributeName>System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field | System.AttributeTargets.All, AllowMultiple=true)</AttributeName>

318

</Attribute>

319

</Attributes>

320

</Type>

Older »