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

CustomFormatReader Methods

The CustomFormatReader type exposes the following members.


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.)

See Also