<attribute> Element

Specifies information about an attribute for this property.

Syntax

<attribute
    name="attributeName" 
    required="true | false"
>

Attributes

name

 

Specifies the name of this attribute.

Allowable values: Any string.

Use: Required

Type: xs:string.

Default value: None.

required

Specifies whether this attribute must be set by a developer using the control.

You might set the required attribute to true if the attribute to which it applies must have a value, but the value can only be known at design time (when a developer is building an app with the control), or when there is no useful default value. In fact, setting the required attribute to true means that the attribute to which it applies can not have a default value. If you set the required attribute to false, then you must provide a default value because a developer using the control is not required to set a value.

Allowable values: true or false.

Use: Required.

Type: xs:boolean.

Default value: None.

Type

This element can contain description, type, and default-value elements.

Hierarchy

Parent: control-tag, method-tag, or attribute-group.

Children: description, type, default-value.

Remarks

None.

Related Topics

Control Property Schema Reference

Tutorial: Java Control