STK AgAttrAutomation	Send comments on this topic.
AddChoicesFuncDispatchProperty Method (IAgAttrBuilder)
See Also

DispScope: The attribute container (scope) where the attribute will be added.

Name: Name of the attribute to add, it is recommended that the name does not include spaces because certain interfaces to the properties may not work correctly.

Description: Description of the attribute to add.

PropName: Name of the property to be called to set/get the value of this attribute. The property must be of the same type as that of the values in the array returned by the class property (a property declared in the scope of the plugin class).

FuncPropName: Name of a class property (a property declared in the scope of the plugin class) returning an array of choices. Used to populate the combo box choices.

Description

It is recommended that any name used for these configuration properties not include spaces because certain interfaces to the properties may not work correctly.

Syntax

[Visual Basic .NET]
Public Sub AddChoicesFuncDispatchProperty( _ ByVal DispScope As Object, _ ByVal Name As String, _ ByVal Description As String, _ ByVal PropName As String, _ ByVal FuncPropName As String _ )

[Visual Basic .NET]

Public Sub AddChoicesFuncDispatchProperty( _
    ByVal DispScope As Object, _
    ByVal Name As String, _
    ByVal Description As String, _
    ByVal PropName As String, _
    ByVal FuncPropName As String _
)

[C#]
public void AddChoicesFuncDispatchProperty( Object DispScope, string Name, string Description, string PropName, string FuncPropName );

[C#]

public void AddChoicesFuncDispatchProperty(
    Object DispScope,
    string Name,
    string Description,
    string PropName,
    string FuncPropName
);

[Managed C++]
public: void AddChoicesFuncDispatchProperty( IUnknown ^ DispScope, String __gc ^ Name, String __gc ^ Description, String __gc ^ PropName, String __gc ^ FuncPropName );

[Managed C++]

public: void AddChoicesFuncDispatchProperty(
    IUnknown ^ DispScope,
    String __gc ^ Name,
    String __gc ^ Description,
    String __gc ^ PropName,
    String __gc ^ FuncPropName
);

[Unmanaged C++]
public: HRESULT AddChoicesFuncDispatchProperty( IUnknown * DispScope, BSTR Name, BSTR Description, BSTR PropName, BSTR FuncPropName );

[Unmanaged C++]

public: HRESULT AddChoicesFuncDispatchProperty(
    IUnknown * DispScope,
    BSTR Name,
    BSTR Description,
    BSTR PropName,
    BSTR FuncPropName
);

[Java]
public void addChoicesFuncDispatchProperty( Object DispScope, String Name, String Description, String PropName, String FuncPropName );

[Java]

public void addChoicesFuncDispatchProperty(
    Object DispScope,
    String Name,
    String Description,
    String PropName,
    String FuncPropName
);

[Python - STK API ]
def AddChoicesFuncDispatchProperty(self, DispScope:"IDispatch", Name:str, Description:str, PropName:str, FuncPropName:str) -> None:

[Python - STK API

]

def AddChoicesFuncDispatchProperty(self, DispScope:"IDispatch", Name:str, Description:str, PropName:str, FuncPropName:str) -> None:

Parameters

DispScope: The attribute container (scope) where the attribute will be added.
Name: Name of the attribute to add, it is recommended that the name does not include spaces because certain interfaces to the properties may not work correctly.
Description: Description of the attribute to add.
PropName: Name of the property to be called to set/get the value of this attribute. The property must be of the same type as that of the values in the array returned by the class property (a property declared in the scope of the plugin class).
FuncPropName: Name of a class property (a property declared in the scope of the plugin class) returning an array of choices. Used to populate the combo box choices.

Example

Add an Attribute that provides a combobox of values populated by a function from which the user can choose.