Class TokenFindMatch
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Provides information about a variable or inline function reference found in an object
[DataContract]
public sealed class TokenFindMatch- Inheritance
-
objectTokenFindMatch
Fields
Result
The TokenFindResult this match belongs to
public readonly TokenFindResult ResultField Value
Properties
FieldName
The name of the field that contains the match
public string FieldName { get; }Property Value
- string
HasSecondaryObject
Indicates whether ObjectOID has a value
public bool HasSecondaryObject { get; }Property Value
- bool
Location
A description of the location where the match was found
public string Location { get; }Property Value
- string
Remarks
This will be the "path" to the object that contains the match. For example, if it was found within a job step, the Location may be set to "Step 1".
ObjectOID
The OID of the object in which the match was found
public OID ObjectOID { get; }Property Value
Remarks
The ObjectOID will be the OID of the top-level object (Job, Job Group, etc.) where the match was found. The ObjectOID of the TokenMatch will be the OID of the object where the match was found. For example if the match was found in a task, the ObjectOID will be the OID of the Task, while ObjectOID will be the OID of the job that contains the task.
ParentOID
The OID of the object that is the immediate owner of the object in which the match was found.
public OID ParentOID { get; }Property Value
Token
The token (variable or function name)
public string Token { get; }Property Value
- string
TokenType
The type of token
public TextTokenType TokenType { get; }Property Value
VariableValue
Shows the defined value of the variable when TokenType is VariableDefinition.
public string VariableValue { get; }Property Value
- string
Methods
GetSecondaryObject()
Gets the object in which the match was found.
public ADTObject GetSecondaryObject()Returns
Remarks
See ObjectOID for more information.