Class PropertyAttribute

Allows attaching an attribute to a property which controls various aspects on how it will look when shown via the inspector.

Inheritance
System.Object
System.Attribute
PropertyAttribute
Inherited Members
System.Attribute.Equals(System.Object)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetHashCode()
System.Attribute.IsDefaultAttribute()
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Module, System.Type)
System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.Match(System.Object)
System.Attribute.TypeId
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: AGS.API
Assembly: AGS.API.dll
Syntax
[AttributeUsage(AttributeTargets.Property)]
public class PropertyAttribute : Attribute

Constructors

| Improve this Doc View Source

PropertyAttribute()

Declaration
public PropertyAttribute()

Properties

| Improve this Doc View Source

Browsable

Gets or sets a value indicating whether this PropertyAttribute will be visible in the inspector.

Declaration
public bool Browsable { get; set; }
Property Value
Type Description
System.Boolean

true if browsable; otherwise, false.
| Improve this Doc View Source

Category

Gets or sets the category (this will override the component name, if part of a component, or the "General" category for all other properties).

Declaration
public string Category { get; set; }
Property Value
Type Description
System.String

The category.
| Improve this Doc View Source

CategoryExpand

Gets or sets whether to expand the category automatically when opening the inspector (this should match between all the properties in the category for accurate results).

Declaration
public bool CategoryExpand { get; set; }
Property Value
Type Description
System.Boolean

Expand Category?
| Improve this Doc View Source

CategoryZ

Gets or sets the category's z index for sorting in the inspector (this should match between all the properties in the category for accurate results).

Declaration
public int CategoryZ { get; set; }
Property Value
Type Description
System.Int32

The category z.
| Improve this Doc View Source

Description

Gets or sets the description (this will override the xml docs on the property if set).

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

The description.
| Improve this Doc View Source

DisplayName

Gets or sets the display name (this will override the property name if set).

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

The display name.
| Improve this Doc View Source

ForceReadonly

Forces the property to be shown as readonly in the inspector (even if it can be set by script).

Declaration
public bool ForceReadonly { get; set; }
Property Value
Type Description
System.Boolean

true to force readonly; otherwise, false.