Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

XmlProperty Directive Attributes

The XmlProperty directive XmlProperty directive has six possible attributes. The Name attribute is required, and the other attributes are optional.

...

Info

If you do not specify a value for the Schema attribute, then the user can select any XML document at runtime, and the property will return an instance of the XmlDocument class.

Default

The Default attribute Default attribute is used to set the default value for this property. If you omit this attribute, then CodeSmith Generator does not supply a default value for the property.

Category

The Category attribute Category attribute specifies what category this property should appear under in the CodeSmith Explorer property sheet. If you omit this attribute, CodeSmith Generator will place the property in a category named Misc.

Description

The Description attribute Description attribute supplies descriptive text to be displayed at the bottom of the property sheet when this property is selected.

Optional

The Optional attribute Optional attribute specifies whether or not this property is optional. If a user does not specify a parameter that is not optional then CodeSmith Generator will not let them proceed. A value of true means that a value for the property is not required, and a value of false means that a value for the property is required.

OnChanged

The OnChanged attribute specifies the event handler to fire when the XmlProperty value changes.

RootElement

The RootElement attribute specifies the relative or full path to the locate the Root Xml Element.

Note

XmlProperty does not support all variations and features of XSD schemas. In general, if an XSD schema can be successfully loaded into the Visual Studio .NET schema designer then it should work in CodeSmith Generator.

...