---
title: "CustomFormatReader Methods "
canonical: https://www.graphicsmill.com/docs/gm5/Methods_T_Aurigma_GraphicsMill_Codecs_CustomFormatReader.htm
product: "Graphics Mill 5.5 for .NET"
---
This documentation is for the old version. [Go to the latest Graphics Mill docs](https://www.graphicsmill.com/docs/gm/)
# CustomFormatReader Methods
The [CustomFormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_CustomFormatReader.htm.md) type exposes the following members.
## Methods
| | Name | Description |
| --- | --- | --- |
|  | [{dtor}](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_%7Bdtor%7D.htm.md) | Enables using delete operator in C++ applications. It is strongly not recommended to use it directly. |
|  | [Abort](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Abort.htm.md) | Aborts current operation.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [CheckForSupport](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatReader_CheckForSupport.htm.md) | Overloaded.
Checks if the image can be loaded with this reader. |
|  | [CheckOpened](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_CheckOpened.htm.md) | Checks if the format reader is opened.
(Overrides [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).[CheckOpened()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_CheckOpened.htm.md).) |
|  | [Close](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_Close.htm.md) | Closes format reader, and detaches it from previously opened file (or other media).
(Inherited from [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).) |
|  | [CloseReader](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_CloseReader.htm.md) | Closes the format reader, and detaches it from a previously opened file (or other media). |
|  | [Continue](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Continue.htm.md) | Resumes execution of the operation previously paused with [Pause()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Pause.htm.md) method.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [Dispose](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_Dispose.htm.md) | Releases all resources used by this [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).
(Inherited from [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).) |
|  | [Equals](http://msdn2.microsoft.com/en-us/bsc2ak47) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [GetEmptyFrame](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetEmptyFrame.htm.md) | Returns an empty [CustomFrame](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_CustomFrame.htm.md) associated with this reader. |
|  | [GetEnumerator](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_GetEnumerator.htm.md) | Returns an enumerator for the frames allowing the writer to be used in **foreach** blocks.
(Inherited from [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).) |
|  | [GetFrameIndexToLoad](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetFrameIndexToLoad.htm.md) | Returns an index of the frame being loaded. |
|  | [GetHashCode](http://msdn2.microsoft.com/en-us/zdee4b3y) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [GetLoadingFrame](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetLoadingFrame.htm.md) | Returns the frame being loaded. |
|  | [GetLoadingMode](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetLoadingMode.htm.md) | Returns a mode, in which the frame is going to be loaded: either a bitmap or a thumbnail. |
|  | [GetThumbnailHeightToLoad](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetThumbnailHeightToLoad.htm.md) | Returns the requested thumbnail height. |
|  | [GetThumbnailWidthToLoad](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_GetThumbnailWidthToLoad.htm.md) | Returns the requested thumbnail width. |
|  | [GetType](http://msdn2.microsoft.com/en-us/dfwy45w9) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [IsSupported](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_IsSupported_1_bca7c9fe.htm.md) | Returns whether this reader can handle the specified file (stream). |
|  | [LoadFrame](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_LoadFrame_1_e1836fc4.htm.md) | Returns a frame with specified index. This frame contains a bitmap and possible other details describing it.
(Inherited from [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).) |
|  | [LoadFrameBitmap](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_LoadFrameBitmap.htm.md) | Loads the frame bitmap. |
|  | [LoadFrameParameters](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_LoadFrameParameters.htm.md) | Loads frame parameters. |
|  | [Lock](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Lock.htm.md) | Locks the object.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [MemberwiseClone](http://msdn2.microsoft.com/en-us/57ctke0a) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [OnCheckForSupport](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_OnCheckForSupport_1_bca7c9fe.htm.md) | Checks if the codec can read the specified file.
(Overrides [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).[OnCheckForSupport(Stream)](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_OnCheckForSupport_1_bca7c9fe.htm.md).) |
|  | [OnClose](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_OnClose.htm.md) | Frees resources when the reader closes.
(Overrides [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).[OnClose()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_OnClose.htm.md).) |
|  | [OnOpen](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_OnOpen.htm.md) | Called when the reader is opened.
(Overrides [FormatReader](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_FormatReader.htm.md).[OnOpen()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_FormatReader_OnOpen.htm.md).) |
|  | [Open](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatReader_Open.htm.md) | Overloaded.
Opens format reader on specified media. |
|  | [OpenReader](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatReader_OpenReader.htm.md) | Overloaded.
Opens the reader. |
|  | [Pause](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Pause.htm.md) | Pauses execution of the current operation.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [ResetEvents](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_ResetEvents_1_e1836fc4.htm.md) | Initializes a progress state while loading a bitmap or a thumbnail. |
|  | [SetDefaultExtension](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetDefaultExtension_1_bb3a7a4f.htm.md) | Sets the default extension of files opened using this codec. |
|  | [SetFilterString](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetFilterString_1_bb3a7a4f.htm.md) | Sets the filter string for the **Open file** dialog. |
|  | [SetFormatDescription](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetFormatDescription_1_bb3a7a4f.htm.md) | Sets the description of the codec. |
|  | [SetFormatName](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetFormatName_1_bb3a7a4f.htm.md) | Sets the name of the codec. |
|  | [SetFrameCount](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetFrameCount_1_e1836fc4.htm.md) | Sets the maximum possible frame count supported by this codec. |
|  | [SetLoadedBitmap](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetLoadedBitmap_1_fd4033ef.htm.md) | Set the bitmap for the current frame. |
|  | [SetMediaFormat](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetMediaFormat_1_5f4f955f.htm.md) | Sets the unique media format identifier for the codec. |
|  | [SetMimeType](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_Codecs_CustomFormatReader_SetMimeType_1_bb3a7a4f.htm.md) | Sets the MIME type of the files opened with the codec. |
|  | [ToString](http://msdn2.microsoft.com/en-us/7bxwbwt2) | (Inherited from [Object](http://msdn2.microsoft.com/en-us/e5kfa45b).) |
|  | [Unlock](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Unlock.htm.md) | Unlocks the object previously locked with method [Lock()](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_Lock.htm.md).
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
|  | [UpdateEvents](https://www.graphicsmill.com/docs/gm5/O_T_Aurigma_GraphicsMill_Codecs_CustomFormatReader_UpdateEvents.htm.md) | Overloaded.
Updates the progress state while loading a bitmap or a thumbnail. |
|  | [WaitForCompletion](https://www.graphicsmill.com/docs/gm5/M_Aurigma_GraphicsMill_SyncHandler_WaitForCompletion.htm.md) | Suspends the calling thread until the operation currently run is completed.
(Inherited from [SyncHandler](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_SyncHandler.htm.md).) |
## See Also
### Reference
- [CustomFormatReader Class](https://www.graphicsmill.com/docs/gm5/T_Aurigma_GraphicsMill_Codecs_CustomFormatReader.htm.md)
- [Aurigma.GraphicsMill.Codecs Namespace](https://www.graphicsmill.com/docs/gm5/N_Aurigma_GraphicsMill_Codecs.htm.md)