Click or drag to resize

GHAPropertyAttribute Constructor

[This is preliminary documentation and is subject to change.]

Adds specific attributes to GHA Properties for handling by consuming objects

Namespace:  GHASchema.Attributes
Assembly:  GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)
Syntax
C#
public GHAPropertyAttribute(
	string description = "",
	bool isReadonly = false,
	bool isBindable = true,
	bool isRequired = false,
	bool isBrowsable = false,
	bool isMomentary = false,
	string specialHandling = "",
	Aggregation aggregation = Aggregation.None,
	bool isVisible = true,
	bool isEnumeration = false,
	string filter = "",
	bool isSaveOnChange = false,
	bool isDebugVisible = false,
	bool isSortKey = false
)

Parameters

description (Optional)
Type: SystemString
Text stating the purpose of the property
isReadonly (Optional)
Type: SystemBoolean
Property should not be changed by GUI's
isBindable (Optional)
Type: SystemBoolean
Property may be used as a binding point
isRequired (Optional)
Type: SystemBoolean
Not used
isBrowsable (Optional)
Type: SystemBoolean
Not used
isMomentary (Optional)
Type: SystemBoolean
Property resets to it's default state after being processed
specialHandling (Optional)
Type: SystemString
An application-specific field that can be used tag the property for special handling (i.e. GUI rendering a specific control to display the property)
aggregation (Optional)
Type: Aggregation
Defines the method used by parent objects to aggregate the property from children
isVisible (Optional)
Type: SystemBoolean
Determines if the property should be visible in a consuming application
isEnumeration (Optional)
Type: SystemBoolean
Tags the property as an enumeration type
filter (Optional)
Type: SystemString
Used for IGHAObjects. The data type that is compatible with this property
isSaveOnChange (Optional)
Type: SystemBoolean
Instructs GHA to save it's current state when the property is changed
isDebugVisible (Optional)
Type: SystemBoolean
Safe to show this property when in debug mode. Some properties are not serializable, so use with caution
isSortKey (Optional)
Type: SystemBoolean
Tells GHA that this property is the sort selection property for the parent class The name of a propery of the children of the parent class will go here. The property with this tag, must be a string
See Also