CustomFormatReader Members
The CustomFormatReader type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
CustomFormatReader |
Creates and initializes a new CustomFormatReader class instance. |
Methods
| Name | Description | |
|---|---|---|
|
{dtor} |
Enables using delete operator in C++ applications. It is strongly not recommended to use it directly. |
|
|
Abort |
Aborts current operation. (Inherited from SyncHandler.) |
|
|
CheckForSupport | Overloaded. Checks if the image can be loaded with this reader. |
|
|
CheckOpened |
Checks if the format reader is opened. (Overrides FormatReader.CheckOpened().) |
|
|
Close |
Closes format reader, and detaches it from previously opened file (or other media). (Inherited from FormatReader.) |
|
|
CloseReader |
Closes the format reader, and detaches it from a previously opened file (or other media). |
|
|
Continue |
Resumes execution of the operation previously paused with Pause() method. (Inherited from SyncHandler.) |
|
|
Dispose |
Releases all resources used by this FormatReader. (Inherited from FormatReader.) |
|
|
Equals | (Inherited from Object.) |
|
|
GetEmptyFrame |
Returns an empty CustomFrame associated with this reader. |
|
|
GetEnumerator |
Returns an enumerator for the frames allowing the writer to be used in foreach blocks. (Inherited from FormatReader.) |
|
|
GetFrameIndexToLoad |
Returns an index of the frame being loaded. |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetLoadingFrame |
Returns the frame being loaded. |
|
|
GetLoadingMode |
Returns a mode, in which the frame is going to be loaded: either a bitmap or a thumbnail. |
|
|
GetThumbnailHeightToLoad |
Returns the requested thumbnail height. |
|
|
GetThumbnailWidthToLoad |
Returns the requested thumbnail width. |
|
|
GetType | (Inherited from Object.) |
|
|
IsSupported |
Returns whether this reader can handle the specified file (stream). |
|
|
LoadFrame |
Returns a frame with specified index. This frame contains a bitmap and possible other details describing it. (Inherited from FormatReader.) |
|
|
LoadFrameBitmap |
Loads the frame bitmap. |
|
|
LoadFrameParameters |
Loads frame parameters. |
|
|
Lock |
Locks the object. (Inherited from SyncHandler.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
OnCheckForSupport |
Checks if the codec can read the specified file. (Overrides FormatReader.OnCheckForSupport(Stream).) |
|
|
OnClose |
Frees resources when the reader closes. (Overrides FormatReader.OnClose().) |
|
|
OnOpen |
Called when the reader is opened. (Overrides FormatReader.OnOpen().) |
|
|
Open | Overloaded. Opens format reader on specified media. |
|
|
OpenReader | Overloaded. Opens the reader. |
|
|
Pause |
Pauses execution of the current operation. (Inherited from SyncHandler.) |
|
|
ResetEvents |
Initializes a progress state while loading a bitmap or a thumbnail. |
|
|
SetDefaultExtension |
Sets the default extension of files opened using this codec. |
|
|
SetFilterString |
Sets the filter string for the Open file dialog. |
|
|
SetFormatDescription |
Sets the description of the codec. |
|
|
SetFormatName |
Sets the name of the codec. |
|
|
SetFrameCount |
Sets the maximum possible frame count supported by this codec. |
|
|
SetLoadedBitmap |
Set the bitmap for the current frame. |
|
|
SetMediaFormat |
Sets the unique media format identifier for the codec. |
|
|
SetMimeType |
Sets the MIME type of the files opened with the codec. |
|
|
ToString | (Inherited from Object.) |
|
|
Unlock |
Unlocks the object previously locked with method Lock(). (Inherited from SyncHandler.) |
|
|
UpdateEvents | Overloaded. Updates the progress state while loading a bitmap or a thumbnail. |
|
|
WaitForCompletion |
Suspends the calling thread until the operation currently run is completed. (Inherited from SyncHandler.) |
Properties
| Name | Description | |
|---|---|---|
|
CodecPriority |
Returns the priority of the codec. (Inherited from FormatReader.) |
|
|
Completed |
Returns value indicating if the operation is currently running. (Inherited from SyncHandler.) |
|
|
DefaultExtension |
Returns default extension for this format. (Inherited from FormatReader.) |
|
|
ExceptionThrowEnabled |
Gets/sets value that specifies if to throw exception in synchronous mode. (Inherited from SyncHandler.) |
|
|
FilterString |
Returns filter string for this format. (Inherited from FormatReader.) |
|
|
FormatDescription |
Returns user-friendly format description. (Inherited from FormatReader.) |
|
|
FormatName |
Returns format name. (Inherited from FormatReader.) |
|
|
FrameCount |
Returns number of frames in the format reader. (Inherited from FormatReader.) |
|
|
IsFrameSeekable |
Check whether the reader supports random access to frames. (Inherited from FormatReader.) |
|
|
Locked |
Indicates if the object has been locked. (Inherited from SyncHandler.) |
|
|
MediaFormat |
Returns the ID of the media format this reader can read from. (Inherited from FormatReader.) |
|
|
MimeType |
Returns mime type of the format. (Inherited from FormatReader.) |
|
|
Opened |
Returns value that specifies whether the reader is opened. (Inherited from FormatReader.) |
|
|
Priority |
Gets/sets a priority for the auxilary thread. (Inherited from SyncHandler.) |
|
|
SynchronizationMode |
Gets/sets synchronization mode for the object. (Inherited from SyncHandler.) |
|
|
Timeout |
Gets/sets value specifying maximum time for which object can be locked. (Inherited from SyncHandler.) |
Events
| Name | Description | |
|---|---|---|
|
Aborted |
Fires when operation has been aborted. (Inherited from SyncHandler.) |
|
|
Continued |
Fires when operation has been resumed with Continue() method. (Inherited from SyncHandler.) |
|
|
Paused |
Fires when operation has been paused with Pause() method. (Inherited from SyncHandler.) |
|
Progress |
Fires on the operation progress notifications. (Inherited from SyncHandler.) |
|
|
Started |
Fires after operation has been started. (Inherited from SyncHandler.) |
|
|
Starting |
Fires before operation is started. (Inherited from SyncHandler.) |
|
|
Stopped |
Fires after operation has been stopped. (Inherited from SyncHandler.) |
|
|
Stopping |
Fires before operation is stopped. (Inherited from SyncHandler.) |