Class SmartText

Represents a smart text value.

Inheritance

System.Object

SmartObject

SmartText

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 8, 0, 0)]
public class SmartText : SmartObject

Remarks

This class is available since v7.8.

Constructors

SmartText(String)

Initializes a new instance of the SmartText class of type Basic.

Declaration

public SmartText(string inValue)

Parameters

Type	Name	Description
System.String	inValue	Value.

SmartText(ElementId)

Initializes a new instance of the SmartText class of type Element.

Declaration

public SmartText(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of providing element.

SmartText(ElementId, ItemLabel)

Initializes a new instance of the SmartText class of type Item.

Declaration

public SmartText(ElementId inElementId, ItemLabel inItemLabel)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of providing element.
ItemLabel	inItemLabel	Label of providing element item.

SmartText(SmartTextType, String, ElementId, ItemLabel, String)

Initializes a new instance of the SmartText class.

Declaration

public SmartText(SmartTextType inType, string inValue, ElementId inElementId, ItemLabel inItemLabel, string inFormula)

Parameters

Type	Name	Description
SmartTextType	inType	Type of smart text.
System.String	inValue	Value, or null if unknown.
ElementId	inElementId	Identifier of providing element, or Empty for none.
ItemLabel	inItemLabel	Label of providing element item, or Empty for none.
System.String	inFormula	Formula, or null for none.

Examples

How to create a text parameter made by concatenating the values of two existing text parameters named "t1" and "t2":

 SmartText smartText = new SmartText(SmartTextType.Formula, null, ElementId.Empty, ItemLabel.Empty, "t1 & t2");
    ElementId eltId = TopSolidHost.Parameters.CreateSmartTextParameter(docId, smartText);

SmartText(SmartTextType, String, ElementId, ItemLabel, String, ScriptType)

Initializes a new instance of the SmartText class.

Declaration

public SmartText(SmartTextType inType, string inValue, ElementId inElementId, ItemLabel inItemLabel, string inFormula, ScriptType inScriptType)

Parameters

Type	Name	Description
SmartTextType	inType	Type of smart text.
System.String	inValue	Value, or null if unknown.
ElementId	inElementId	Identifier of providing element, or Empty for none.
ItemLabel	inItemLabel	Label of providing element item, or Empty for none.
System.String	inFormula	Formula, or null for none.
ScriptType	inScriptType	ScripType

Fields

ElementId

Providing element identifier, or empty if none.

Declaration

public ElementId ElementId

Field Value

Type	Description
ElementId

Formula

Formula, or null if none.

Declaration

public string Formula

Field Value

Type	Description
System.String

ItemLabel

Providing element item label, or empty if none.

Declaration

public ItemLabel ItemLabel

Field Value

Type	Description
ItemLabel

ScriptType

Type of script.

Declaration

public ScriptType ScriptType

Field Value

Type	Description
ScriptType

Type

Type of smart text.

Declaration

public SmartTextType Type

Field Value

Type	Description
SmartTextType

Value

Value, or null if unknown.

Declaration

public string Value

Field Value

Type	Description
System.String