| NativeBuffer Class |
A buffer for calls to INativeExtractionContentHandler and INativeGenerationContentHandler
Set the Output property on the buffer to the correct derived type.
Strongly typed properties ExtractionOutput and GenerationOutput
Both map to the same Output instance, and can be used equivocally.
Start buffering calls by calling Hold, and stops buffering
by calling Release. When Release is called, any calls that are
in the buffer will be invoked on the Output,
or Output.
If Release is called after EndOfInput is received and there is content left in the
buffer, an exception is thrown, since the output should not be generated after EndOfInput.
It is the buffer user's responsibility to ensure that the buffer is emptied before
end of input is called for the parser components following it.
Inheritance HierarchyNamespace: Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.Buffer
Assembly: Sdl.FileTypeSupport.Framework.Core.Utilities (in Sdl.FileTypeSupport.Framework.Core.Utilities.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxThe NativeBuffer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NativeBuffer |
Default constructor, creates an empty buffer where IsHolding is false.
|
Properties| Name | Description | |
|---|---|---|
 | BufferedCalls |
Provides access to the calls currently in the buffer.
|
| ExtractionOutput |
Strongly typed output content handler that can be used
when the buffer is used for extraction.
|
| GenerationOutput |
Strongly typed output content handler that can be used
when the buffer is used for generation.
|
| IsEndOfInput |
True, if EndOfInput has been reached. After that, Release() is no longer
permitted if the buffer contains any content.
This property can be set to override this behaviour, but that is an
advanced option that should only be exercised if no other option is available.
|
| IsHolding |
Indicates whether the buffer is actively buffering calls.
|
| LastBufferedCall |
Provides easy access to the most recent of the calls in the buffer.
If no calls are in the buffer, this property returns null.
|
| Output |
Agnostic access to the output handler. Accesses the
very same object instance as the ExtractionOutput
and the GenerationOutput properties.
|
Methods| Name | Description | |
|---|---|---|
| ChangeContext |
Adds content to buffer if holding, otherwise output directly.
|
| CommentEnd |
Adds to buffer if holding, otherwise output directly.
|
| CommentStart |
Adds to buffer if holding, otherwise output directly.
|
| CustomInfo |
Adds content to buffer if holding, otherwise output directly.
|
| EndOfInput |
Sets the end of input flag.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Hold |
Call this to start buffering calls.
|
| InlineEndTag |
Adds content to buffer if holding, otherwise output directly.
|
| InlinePlaceholderTag |
Adds content to buffer if holding, otherwise output directly.
|
| InlineStartTag |
Adds content to buffer if holding, otherwise output directly.
|
| LocationMark |
Add to buffer if holding, otherwise output directly.
|
| LockedContentEnd |
Adds to buffer if holding, otherwise output directly.
|
| LockedContentStart |
Adds content to buffer if holding, otherwise output directly.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ParagraphComments |
Adds to buffer if holding, otherwise output directly.
|
| ParagraphUnitEnd |
Adds to buffer if holding, otherwise output directly.
|
| ParagraphUnitStart |
Adds to buffer if holding, otherwise output directly.
|
| Release |
Releases the buffer content to the Output and turns off buffering.
|
| RevisionEnd |
Adds to buffer if holding, otherwise output directly.
|
| RevisionStart |
Adds to buffer if holding, otherwise output directly.
|
| SegmentEnd |
Adds to buffer if holding, otherwise output directly.
|
| SegmentStart |
Adds to buffer if holding, otherwise output directly.
|
| SetFileProperties |
Default implementation, does nothing
|
| StartOfInput |
Default implementation, does nothing
|
| StructureTag |
Adds content to buffer if holding, otherwise output directly.
|
| Text |
Adds content to buffer if holding, otherwise output directly.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See AlsoCommunityComments