Methods
Returns the area value for a selected object id in a specified unit system
Returns the area value for a selected object id
Parameters:
| id (string) |
User text associated with a block
Returns a block definition description
Parameters:
| definitionNameOrId (string) |
Returns the insertion coordinate of a block instance. If the field is being evaluated from text inside a block instance, the immediate parent block instance is used.
Returns the number of block instances found in the document with the specified block definition name or the instance reference id.
Parameters:
| instanceDefinitionNameOrId (string) |
Returns the block definition name of a block instance Use BlockName Instead
Parameters:
| blockId (string) |
Returns the block definition name of a block instance
Parameters:
| blockId (string) |
Get length of a curve given a string id in a specified unit system. UnitSystem enumeration as string
Get length of a curve given a string id
Parameters:
| id (string) |
Current Date in a specific format and language
Current date in a specified format
Parameters:
| dateFormat (string) |
Date the document was last edited in a specific format and language in local time
Date the document was last edited in a specified format
Parameters:
| dateFormat (string) |
Returns a detail views scale
Returns the measured value of a dimension formatted with the named annotation style.
Returns the measured value of a dimension formatted with the dimension's own annotation style.
Parameters:
| dimensionId (string) |
Return document user string for a given key
Parameters:
| key (string) |
Return path to the document
Parameters:
| options (string) |
public static TextFields.InstanceAttributeField[] GetInstanceAttributeFields(InstanceDefinition idef)
Parameters:
| idef (InstanceDefinition) |
Gets an array of block attribute definitions associated with a TextObject.
Parameters:
| str (string) | TextObject to check for block attribute definitions |
Returns: Will return a empty array if text is null or there is no attributes otherwise; returns a list of one or more attribute definitions embedded in the text string.
Gets an array of block attribute definitions associated with a TextObject.
Parameters:
| text (TextObject) | TextObject to check for block attribute definitions |
Returns: Will return a empty array if text is null or there is no attributes otherwise; returns a list of one or more attribute definitions embedded in the text string.
Returns the name of a layer based on the layers guid
Parameters:
| layerId (string) |
Returns a value from the active layouts user text strings for the specified key.
Parameters:
| key (string) |
Returns user text value from a layout id Key
Return an object's layer name
Parameters:
| id (string) |
Returns an attached Text objects attribute name.
Return an object's name
Parameters:
| id (string) |
Returns the layout page name the object resides on
Parameters:
| id (string) |
Returns the layout page number the object resides on
Parameters:
| id (string) |
Return the current layout page height in the layout units
Return the page name for the specified View ID
Parameters:
| id (string) |
Return the current layout page width in the layout units
Returns the layouts selected paper name example Letter / A4 / A6
returns the location of a 3d point
Formats the contents of a text string with field expressions and returns the result.
The text is evaluated with no object context, which suits fields that read only the document, such as Date or ModelUnits. Fields that read the object itself or the block instance enclosing it - user text, for example - cannot resolve this way and will come back empty; use the overload that takes the object and its parents for those.
Parameters:
| text (string) | The text formula to format |
| doc (RhinoDoc) | The Rhino document to evaluate |
| result (out string) | The result of the formatted expression. Otherwise, if the text is null or the evaluation process fails, the result will be empty. |
Returns: Returns True if the expression is formatted properly; Otherwise False.
public static bool TryFormat(string text, RhinoDoc doc, RhinoObject obj, RhinoObject topParent, InstanceObject immediateParent, out string result)
Formats the contents of a text string with field expressions and returns the result, evaluating it against a specific object and the block instances that enclose it.
Parameters:
| text (string) | The text formula to format |
| doc (RhinoDoc) | The Rhino document to evaluate |
| obj (RhinoObject) | The object the text belongs to, or null. Fields that read the object itself, such as its user text, need this. |
| topParent (RhinoObject) | The top level object the text belongs to, or null to use obj. |
| immediateParent (InstanceObject) | The block instance directly containing obj, or null. Fields that read user text off the enclosing instance need this. |
| result (out string) | The result of the formatted expression. Otherwise, if the text is null or the evaluation process fails, the result will be empty. |
Returns: Returns True if the expression is formatted properly; Otherwise False.
Evaluates the contents of a text string with field expressions and returns the result
Parameters:
| text (string) | The text formula to parse and evaluate |
| doc (RhinoDoc) | The Rhino document to evaluate |
| result (out List<string>) | The result of the evaluated expression. Otherwise, if the text is null or the evaluation process fails, the result will be empty. |
Returns: Returns True if the expression is evaluated properly; Otherwise False.
User text associated with an object, block or layout
User text associated with an object, block or layout
User text associated with an object, block or layout
Returns a volume; if the opt param is a bool "true/false" or "1/0" then open objects are inspected or ignored. if the opt param is a unit system as a string "millimeter" then the volume will be returned if the object is closed and in the specified unit system. Open objects return 0
Returns a volume from an object Id. If allowOpenObjects = false objects which are open will return 0.0 as a volume.