FunctionDescriptor
Describe a DesignScript function in a imported library
Constructors
No public constructors defined
Methods
No public methods defined
Properties
| String Assembly {get;set;} |
stability index:1 |
| Full path to the assembly the defined this function |
|
| String ClassName {get;set;} |
stability index:1 |
| Class name of this function. If the functino is global function, return String.Empty. |
|
| String FunctionName {get;set;} |
stability index:1 |
| Function name. |
|
| IEnumerable<TypedParameter> Parameters {get;set;} |
stability index:1 |
| Function parameters. |
|
| Type ReturnType {get;set;} |
stability index:1 |
| Function return type. |
|
| IEnumerable<String> ReturnKeys {get;set;} |
stability index:1 |
| If the function returns a dictionary, ReturnKeys is the key collection used in returned dictionary. |
|
| Boolean IsVarArg {get;set;} |
stability index:1 |
| Does the function accept a variable number of arguments? |
|
| FunctionType Type {get;set;} |
stability index:1 |
| Function type. |
|
| String Description {get;} |
stability index:1 |
| A comment describing the function along with the signature |
|
| IEnumerable<Tuple<String,String>> Returns {get;} |
stability index:1 |
| If the XML documentation for the function includes a returns field, this parameter contains a collection of tuples of output names to descriptions. Otherwise, this list will be empty. |
|
| IEnumerable<Tuple<String,String>> InputParameters {get;set;} |
stability index:1 |
| Inputs for Node |
|
| String Category {get;} |
stability index:1 |
| The category of this function. |
|
| String QualifiedName {get;} |
stability index:1 |
| The string that is used to search for this function. |
|
| String MangledName {get;} |
stability index:1 |
| A unique name to identify a function. It is necessary when a function is overloaded. |
|
| String Signature {get;} |
stability index:1 |
| The full signature of the function. |
|
| String UserFriendlyName {get;} |
stability index:1 |
| Return a user friendly name. E.g., for operator '+' it will return 'Add' |
|
| String DisplayName {get;} |
stability index:1 |
| QualifiedName with leading namespaces removed. |
|
| Boolean IsVisibleInLibrary {get;set;} |
stability index:1 |
| This attribute sets, if this function is shown in library or not. |
|
| Boolean CanUpdatePeriodically {get;set;} |
stability index:1 |
| This attribute sets whether the function enables periodic update of the workspace. |
|
Events
No public events defined
