Class SearchReplaceMatch
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Contains information about a match during a search/replace operation
public class SearchReplaceMatch- Inheritance
-
objectSearchReplaceMatch
Remarks
See SearchReplaceResult for more information.
Properties
FieldDisplayName
User-friendly name of the field where the match was found
public string FieldDisplayName { get; }Property Value
- string
FieldName
The name of the field where the match was found
public string FieldName { get; }Property Value
- string
FindLocation
A user-friendly description of the location where the match was found
public string FindLocation { get; }Property Value
- string
FoundText
The matching text that was found
public string FoundText { get; }Property Value
- string
HasSecondaryObject
Indicates whether SecondaryObjectOID has a value
public bool HasSecondaryObject { get; }Property Value
- bool
ReplacementText
Contains the replacement text used, if TextReplaced is true
public string ReplacementText { get; }Property Value
- string
Result
The SearchReplaceResult this match belongs to
public SearchReplaceResult Result { get; }Property Value
SecondaryObjectOID
Indicates the OID of the secondary object where the match was found.
public OID SecondaryObjectOID { get; }Property Value
Remarks
The SearchReplaceResult indicates the top-level object (such as a Job or JobGroup) that contains the match. If the matching text was found within the top-level object itself, SecondaryObjectOID will be null. If the match was found in a dependent object, SecondaryObjectOID will be set to the OID of that object. For example, if the match was found in a Task, the PrimaryObjectOID will be set to the OID of the job. The SecondaryObjectOID of the SearchReplaceMatch will be set to the OID of the task.
TextReplaced
Indicates whether the text was replaced
public bool TextReplaced { get; }Property Value
- bool
Methods
GetSecondaryObject()
Gets the object in which the match was found.
public ADTObject GetSecondaryObject()Returns
Remarks
See SecondaryObjectOID for more information.
If ObjectSearchOptions.ReturnObjects was set to false, the object will be automatically fetched from the server if necessary. If you plan to need the contents of the objects, set ReturnObjects to true when calling SearchAndReplace(ObjectSearchOptions, out ReadOnlyCollection<SearchReplaceResult>, out MessageCollection) so that all objects are returned at once, rather than requiring multiple calls to the server to fetch them individually.