IParseRequest Interface
Provides the base requirements of a parsing operation request.
public interface IParseRequest
Properties
CreatedDateTime
Gets the System.DateTime at which the parse request was created.
DateTime CreatedDateTime { get; }
Property Value
- System.DateTime:
The System.DateTime at which the parse request was created.
Language
Gets the ISyntaxLanguage for which this parse request was created.
ISyntaxLanguage Language { get; }
Property Value
- ISyntaxLanguage:
The ISyntaxLanguage for which this parse request was created.
ParseHashKey
Gets a hash key that uniquely identifies the parse request for a source/target combination.
string ParseHashKey { get; }
Property Value
- System.String:
A hash key that uniquely identifies the parse request for a source/target combination.
Parser
Gets the IParser that will perform the parsing operation.
IParser Parser { get; }
Property Value
Priority
Gets an integer value describing the priority of the request, where a higher number has a higher priority.
int Priority { get; }
Property Value
- System.Int32:
An integer value describing the priority of the request, where a higher number has a higher priority. The default value is
ParseRequest.MediumPriority
.
RepeatedRequestPause
Gets or sets the number of milliseconds to pause if there are repeated attempts for this same request.
int RepeatedRequestPause { get; set; }
Property Value
- System.Int32:
The number of milliseconds to pause if there are repeated attempts for this same request. The default value is
250
.
Snapshot
Gets the ITextSnapshot, if available, for which the parse request was created.
ITextSnapshot Snapshot { get; }
Property Value
- ITextSnapshot:
The ITextSnapshot, if available, for which the parse request was created.
SourceKey
Gets a text key, typically a filename, that uniquely identifies the text to parse.
string SourceKey { get; }
Property Value
- System.String:
A text key, typically a filename, that uniquely identifies the text to parse.
State
Gets or sets the current state of the request.
ParseRequestState State { get; set; }
Property Value
- ParseRequestState:
The current state of the request.
Remarks
This property should only be set by a IParseRequestDispatcher.
Tag
Gets or sets the object that contains user-defined data about the object.
object Tag { get; set; }
Property Value
- System.Object:
An System.Object that contains user-defined data about the control. The default is
null
.
Remarks
Any type derived from the System.Object class can be assigned to this property.
Target
Gets the IParseTarget that will be notified once the parsing operation is complete.
IParseTarget Target { get; }
Property Value
- IParseTarget:
The IParseTarget that will be notified once the parsing operation is complete.
TextBufferReader
Gets the ITextBufferReader used to read the text that should be parsed.
ITextBufferReader TextBufferReader { get; }
Property Value
- ITextBufferReader:
The ITextBufferReader used to read the text that should be parsed.