Represents a request for a parsing operation.
- Inheritance:
- object object
- Implements:
-
IParse
Request
Constructors
ParseRequest(string, ITextBufferReader, ISyntaxLanguage, IParseTarget)
Initializes a new instance of the ParseRequest
class.
Parameter | Type | Description |
---|---|---|
sourceKey | string | A text key, typically a filename, that uniquely identifies the text to parse. |
textBufferReader | IText |
The IText |
language | ISyntax |
The ISyntax |
parseTarget | IParse |
An IParse |
ParseRequest(string, ITextBufferReader, IParser, IParseTarget)
Initializes a new instance of the ParseRequest
class.
Parameter | Type | Description |
---|---|---|
sourceKey | string | A text key, typically a filename, that uniquely identifies the text to parse. |
textBufferReader | IText |
The IText |
parser | IParser | The IParser that will perform the parsing operation. |
parseTarget | IParse |
An IParse |
Properties
CreatedDateTime
Gets the Date
Language
Gets the ISyntax
Property Value
- ISyntax
Language : The ISyntax
Language for which this parse request was created.
ParseHashKey
Gets a hash key that uniquely identifies the parse request for a source/target combination.
Property Value
- 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.
Priority
Gets or sets an integer value describing the priority of the request, where a higher number has a higher priority.
Property Value
- int:
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.
Property Value
- int:
The number of milliseconds to pause if there are repeated attempts for this same request. The default value is
250
.
Snapshot
Gets or sets the IText
Property Value
- IText
Snapshot : The IText
Snapshot , if available, for which the parse request was created.
SourceKey
Gets a text key, typically a filename, that uniquely identifies the text to parse.
Property Value
- string:
A text key, typically a filename, that uniquely identifies the text to parse.
State
Gets or sets the current state of the request.
Property Value
- Parse
Request :State The current state of the request.
Remarks
This property should only be set by a IParse
Tag
Gets or sets the object that contains user-defined data about the object.
Target
Gets the IParse
Property Value
- IParse
Target : The IParse
Target that will be notified once the parsing operation is complete.
TextBufferReader
Gets the IText
Property Value
- IText
Buffer :Reader The IText
Buffer used to read the text that should be parsed.Reader
Methods
GetParseHashKey(ICodeDocument)
Returns the Parse
Parameter | Type | Description |
---|---|---|
document | ICode |
The ICode |
Returns
- string:
The Parse
Hash to use for the specified ICodeKey Document .
Fields
HighPriority
Specifies a high priority.
LowPriority
Specifies a low priority.
MediumPriority
Specifies a medium priority.