SDK: Property Editor Basics Changing Property Classification
- 26 Feb 2020
- 1 Minute to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
SDK: Property Editor Basics Changing Property Classification
- Updated on 26 Feb 2020
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The way that step properties show up in the designer can be modified using the PropertyClassification attribute. This document shows how to use this attribute.
The following options can be configured for a property:
| Node | This is the node in the property editor in which this property will be displayed. If not set it will show up under '[Settings]'. |
|---|---|
| Order | This is the order in which the property will show up in the designer. If not set, it will show up in alphabetical order. |
| Name | This is the name of the property. If not set, it will show up as the properties name with spaces separating CamelCasing. |
| IsHidden | Controls whether or not the property displays in the designer. If not set, it will be shown. |
Example
The following code shows a property that has had its order, name, and node overridden. Order is 1 instead of the default0. Name is Overridden Name of Property 1 instead of default Property One. Node is Node 1/SubNode A instead of default [Settings].
[PropertyClassification(1, "Overridden Name of Property 1", "Node 1", "SubNode A")]
public string PropertyOne
{
get { return propOne; }
set
{
propOne = value;
}
}
The following code shows a property that has had its node and order overridden. Node is Node 1/SubNode A instead of default [Settings].
[PropertyClassification(new string[] { "Node 1", "SubNode A" }, 0)]
public string PropertyTwo
{
get { return propTwo; }
set
{
propTwo = value;
}
}
Was this article helpful?
