TextFields

TextFields class

This Class Processes Text Field Functions

Derived Classes:

Namespace: Rhino.Runtime
TextFields: references

Constructors (1)

TextFields()

Initializes a new instance of the TextFields class

Methods (48)

Area(string id, string unitSystem)

Returns the area value for a selected object id in a specified unit system

Area(string id)

Returns the area value for a selected object id

BlockAttributeText(string key, string prompt, string defaultValue)

User text associated with a block

BlockDescription(string definitionNameOrId)

Returns a block definition description

BlockInstanceCount(string instanceDefinitionNameOrId)

Returns the number of block instances found in the document with the specified block definition name or the instance reference id.

BlockInstanceName(string blockId)

Returns the block definition name of a block instance Use BlockName Instead

BlockName(string blockId)

Returns the block definition name of a block instance

CurveLength(string id, string unitSystem)

Get length of a curve given a string id in a specified unit system. UnitSystem enumeration as string

CurveLength(string id)

Get length of a curve given a string id

Date()

Current date

Date(string dateFormat, string languageId)

Current Date in a specific format and language

Date(string dateFormat)

Current date in a specified format

DateModified()

Date the document was last edited

DateModified(string dateFormat, string languageId)

Date the document was last edited in a specific format and language in local time

DateModified(string dateFormat)

Date the document was last edited in a specified format

DetailScale(string detailId, string scaleFormat)

Returns a detail views scale

DocumentText(string key)

Return document user string for a given key

FileName()

Return full path to the document

FileName(string options)

Return path to the document

GetInstanceAttributeFields(InstanceDefinition idef)

GetInstanceAttributeFields(string str)

Gets an array of block attribute definitions associated with a TextObject.

GetInstanceAttributeFields(TextObject text)

Gets an array of block attribute definitions associated with a TextObject.

LayerName(string layerId)

Returns the name of a layer based on the layers guid

LayoutUserText(string key)

Returns a value from the active layouts user text strings for the specified key.

LayoutUserText(string layoutId, string key)

Returns user text value from a layout id Key

ModelUnits()

Notes()

Notes for a RhinoDoc

NumPages()

Number of layout pages in a document

ObjectLayer(string id)

Return an object's layer name

ObjectName()

Returns an attached Text objects attribute name.

ObjectName(string id)

Return an object's name

ObjectPageName(string id)

Returns the layout page name the object resides on

ObjectPageNumber(string id)

Returns the layout page number the object resides on

PageHeight()

Return the current layout page height in the layout units

PageName()

Return the current layout page name

PageName(string id)

Return the page name for the specified View ID

PageNumber()

Returns the current layouts page number

PageWidth()

Return the current layout page width in the layout units

PaperName()

Returns the layouts selected paper name example Letter / A4 / A6

PointCoordinate(string pointId, string axis)

returns the location of a 3d point

TryFormat(string text, RhinoDoc doc, out string result)

Formats the contents of a text string with field expressions and returns the result

TryParse(string text, RhinoDoc doc, out List<string> result)

Evaluates the contents of a text string with field expressions and returns the result

UserText(string id, string key, string prompt, string defaultValue)

User text associated with an object, block or layout

UserText(string id, string key, string prompt)

User text associated with an object, block or layout

UserText(string id, string key)

User text associated with an object, block or layout

Volume(string id, string opt)

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

Volume(string id, string unitSystem, string allowOpenObjects)

Returns a volume from an object Id. If allowOpenObjects = False objects which are open will return 0.0 as a volume.

Volume(string id)

Returns the volume for the selected object id open objects return 0 volume

Nothing found