This documentation is for the old version. Go to the latest Graphics Mill docs

CustomFormatReader Members

The CustomFormatReader type exposes the following members.


Name Description
Protected method CustomFormatReader

Creates and initializes a new CustomFormatReader class instance.


Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts current operation.

(Inherited from SyncHandler.)
Public method CheckForSupport Overloaded.

Checks if the image can be loaded with this reader.

Protected method CheckOpened

Checks if the format reader is opened.

(Overrides FormatReader.CheckOpened().)
Public method Close

Closes format reader, and detaches it from previously opened file (or other media).

(Inherited from FormatReader.)
Protected method CloseReader

Closes the format reader, and detaches it from a previously opened file (or other media).

Public method Continue

Resumes execution of the operation previously paused with Pause() method.

(Inherited from SyncHandler.)
Public method Dispose

Releases all resources used by this FormatReader.

(Inherited from FormatReader.)
Public method Equals (Inherited from Object.)
Protected method GetEmptyFrame

Returns an empty CustomFrame associated with this reader.

Public method GetEnumerator

Returns an enumerator for the frames allowing the writer to be used in foreach blocks.

(Inherited from FormatReader.)
Protected method GetFrameIndexToLoad

Returns an index of the frame being loaded.

Public method GetHashCode (Inherited from Object.)
Protected method GetLoadingFrame

Returns the frame being loaded.

Protected method GetLoadingMode

Returns a mode, in which the frame is going to be loaded: either a bitmap or a thumbnail.

Protected method GetThumbnailHeightToLoad

Returns the requested thumbnail height.

Protected method GetThumbnailWidthToLoad

Returns the requested thumbnail width.

Public method GetType (Inherited from Object.)
Protected method IsSupported

Returns whether this reader can handle the specified file (stream).

Public method LoadFrame

Returns a frame with specified index. This frame contains a bitmap and possible other details describing it.

(Inherited from FormatReader.)
Protected method LoadFrameBitmap

Loads the frame bitmap.

Protected method LoadFrameParameters

Loads frame parameters.

Public method Lock

Locks the object.

(Inherited from SyncHandler.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnCheckForSupport

Checks if the codec can read the specified file.

(Overrides FormatReader.OnCheckForSupport(Stream).)
Protected method OnClose

Frees resources when the reader closes.

(Overrides FormatReader.OnClose().)
Protected method OnOpen

Called when the reader is opened.

(Overrides FormatReader.OnOpen().)
Public method Open Overloaded.

Opens format reader on specified media.

Protected method OpenReader Overloaded.

Opens the reader.

Public method Pause

Pauses execution of the current operation.

(Inherited from SyncHandler.)
Protected method ResetEvents

Initializes a progress state while loading a bitmap or a thumbnail.

Protected method SetDefaultExtension

Sets the default extension of files opened using this codec.

Protected method SetFilterString

Sets the filter string for the Open file dialog.

Protected method SetFormatDescription

Sets the description of the codec.

Protected method SetFormatName

Sets the name of the codec.

Protected method SetFrameCount

Sets the maximum possible frame count supported by this codec.

Protected method SetLoadedBitmap

Set the bitmap for the current frame.

Protected method SetMediaFormat

Sets the unique media format identifier for the codec.

Protected method SetMimeType

Sets the MIME type of the files opened with the codec.

Public method ToString (Inherited from Object.)
Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from SyncHandler.)
Protected method UpdateEvents Overloaded.

Updates the progress state while loading a bitmap or a thumbnail.

Public method WaitForCompletion

Suspends the calling thread until the operation currently run is completed.

(Inherited from SyncHandler.)


Name Description
Public property CodecPriority

Returns the priority of the codec.

(Inherited from FormatReader.)
Public property Completed

Returns value indicating if the operation is currently running.

(Inherited from SyncHandler.)
Public property DefaultExtension

Returns default extension for this format.

(Inherited from FormatReader.)
Public property ExceptionThrowEnabled

Gets/sets value that specifies if to throw exception in synchronous mode.

(Inherited from SyncHandler.)
Public property FilterString

Returns filter string for this format.

(Inherited from FormatReader.)
Public property FormatDescription

Returns user-friendly format description.

(Inherited from FormatReader.)
Public property FormatName

Returns format name.

(Inherited from FormatReader.)
Public property FrameCount

Returns number of frames in the format reader.

(Inherited from FormatReader.)
Public property IsFrameSeekable

Check whether the reader supports random access to frames.

(Inherited from FormatReader.)
Public property Locked

Indicates if the object has been locked.

(Inherited from SyncHandler.)
Public property MediaFormat

Returns the ID of the media format this reader can read from.

(Inherited from FormatReader.)
Public property MimeType

Returns mime type of the format.

(Inherited from FormatReader.)
Public property Opened

Returns value that specifies whether the reader is opened.

(Inherited from FormatReader.)
Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
Public property SynchronizationMode

Gets/sets synchronization mode for the object.

(Inherited from SyncHandler.)
Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from SyncHandler.)


Name Description
Public event Aborted

Fires when operation has been aborted.

(Inherited from SyncHandler.)
Public event Continued

Fires when operation has been resumed with Continue() method.

(Inherited from SyncHandler.)
Public event Paused

Fires when operation has been paused with Pause() method.

(Inherited from SyncHandler.)
Protected event Progress

Fires on the operation progress notifications.

(Inherited from SyncHandler.)
Public event Started

Fires after operation has been started.

(Inherited from SyncHandler.)
Public event Starting

Fires before operation is started.

(Inherited from SyncHandler.)
Public event Stopped

Fires after operation has been stopped.

(Inherited from SyncHandler.)
Public event Stopping

Fires before operation is stopped.

(Inherited from SyncHandler.)

See Also