←Select platform
RasterCodecs Class Members
Summary
The following tables list the members exposed by RasterCodecs.
Public Constructors
| Name | Description | |
|---|---|---|
 |
RasterCodecs | Initializes a new instance of the RasterCodecs class. |
Public Methods
| Name | Description | ||
|---|---|---|---|
 |
CancelAsync | Cancels a pending asynchronous operation. | |
|
CancelFeedGetInformation | This method can be used to purposefully cancel the feed information process. | |
|
CancelFeedLoad | This method can be used to purposefully cancel the FeedLoad process. | |
|
CanLoadSvg | Determines whether the specified image, document or vector data in the remote URL can be loaded as SVG. | |
|
CanLoadSvgAsync | Determines whether specified image, document or vector stream can be loaded as SVG. | |
 |
CommentsSupported | Checks whether the given file format supports comment fields | |
|
CompactFile | Compacts TIFF files with specific options. | |
|
Compress | Does buffer-to-buffer JPEG or LEAD CMP compression using an unmanaged memory buffer. | |
|
Convert | Converts an image file from one format to another, creating a new file in the new format. | |
|
ConvertAsync | Converts an image stream from one format to another, creating a new image file in a stream in the new format. | |
|
DecodeAbic | Decodes the input ABIC unmanaged memory data using the ABIC decoder and returns raw uncompressed data. | |
|
Decompress | Called for each unmanaged memory buffer, strip or tile of decompressed data. | |
|
DeleteComment | Deletes a comment field from a file. | |
|
DeleteCommentAsync | Deletes a comment field from a file. | |
|
DeletePage | Deletes the specified page from a multi-page file, if the format supports delete operations. | |
|
DeletePageAsync | Deletes the specified page from a multi-page file in a stream, if the format supports delete operations. | |
|
DeleteTag | Deletes a tag from a file, if the file supports tags (TIFF or Exif). | |
|
DeleteTagAsync | Deletes a tag from a stream, if the file supports tags (TIFF or Exif). | |
|
EncodeAbic | Encodes the input raw unmanaged memory data using the ABIC encoder. | |
|
EnumGeoKeys | Enumerates all the GeoKeys in a Geo TIFF file. | |
|
EnumGeoKeysAsync | Enumerates all the GeoKeys in a Geo TIFF stream. | |
|
EnumTags | Enumerates all the tags in a file. | |
|
EnumTagsAsync | Enumerates all the tags in a stream. | |
|
ExtractXMPMetadata | Extracts all XMP metadata from the source file and saves it to the destination XML file. | |
|
FeedGetInformation | Supplies unmanaged memory image data to the file information process from a buffer that you provide. | |
|
FeedLoad | Supplies unmanaged memory image data to the file-load process from a buffer that you provide. | |
|
FormatSupportsMultipageSave | Gets a value that indicates whether the specified format supports multi-page save operation. | |
|
GeoKeysSupported | Checks whether the given file format supports TIFF GeoKey tags | |
|
GetCodecInformation | Gets information about the specified codec. | |
|
GetCodecsInformation | Gets information about all of the codecs. | |
|
GetExtension | Gets the default file extension for the specified format. | |
|
GetExtensionMimeType | Gets the MIME type associated with the specified file format extension. | |
|
GetFormat | Gets the format of the image URI. | |
|
GetFormatAsync | Gets the format of the image in a stream. | |
|
GetInformation | Gets the specific image page information from the specified Uri. | |
|
GetInformationAsync | Gets the specific image page information from the specified Uri asynchronously. | |
|
GetMimeType | Gets a string that represents the MIME type for the specified RasterImageFormat file format. | |
|
GetMimeTypeExtension | Gets the default extension for the specified MIME type. | |
|
GetPcdResolution | Examines a PhotoCD file to determine which resolutions it contains. | |
|
GetRasterPdfInfo | Gets information about a page in a raster PDF file created with the PDF support available in the LEADTOOLS PDF Pro, Pro Suite, Document or Medical products. | |
|
GetRasterPdfInfoAsync | Gets information about a page in a raster PDF file contained in a stream created with the PDF support available in the LEADTOOLS PDF Pro, Pro Suite, Document or Medical products. | |
|
GetTotalPages | Gets the number of pages of an image URI. | |
|
GetTotalPagesAsync | Gets the number of pages in a stream. | |
|
IgnoreCodecs | Specifies which file codecs LEADTOOLS should NEVER load, even if present. | |
|
IsSvg | Quickly determines whether the URL contains an SVG image. | |
|
IsTiff | Determines if the specified RasterImageFormat is a FileFormatsTIFF file format. | |
|
Load | Loads the specified image URL using specified options. | |
|
LoadAsync | Loads the specified image URL using default options asynchronously. | |
|
LoadCmykPlanes | Loads CMYK TIFF or JPEG files as CMYK and avoids the colorspace conversion to RGB. | |
|
LoadCmykPlanesAsync | Loads CMYK TIFF or JPEG streams as CMYK and avoids the colorspace conversion to RGB. | |
|
LoadOptions | Loads the options into this RasterCodecs from a disk file. | |
|
LoadPsdChannel | Loads the specified channel from the specified PSD file. | |
|
LoadPsdChannelAsync | Loads the specified channel from the specified PSD file. | |
|
LoadPsdLayer | Loads the specified layer from the specified PSD file. | |
|
LoadPsdLayerAsync | Loads the specified layer from the specified PSD file. | |
|
LoadSvg | Loads a page from an image, document or vector file as SVG. | |
|
LoadSvgAsync | Loads a page from a URI containing an image, document or vector file as SVG asynchronously. | |
|
MarkersSupported | Checks whether the given file format supports markers | |
|
MetadataItemsSupported | Checks whether the specified file format supports metadata. | |
|
PreloadCodecs | Specifies the file format codecs to be loaded. | |
|
ReadComment | Gets a comment field from a file. | |
|
ReadCommentAsync | Gets a comment field from a stream. | |
|
ReadComments | Gets all the comment fields stored in a file. | |
|
ReadCommentsAsync | Gets all the comment fields stored in a stream. | |
|
ReadExtensions | Loads extensions from the specified Exif file. | |
|
ReadExtensionsAsync | Loads extensions from the specified Exif stream. | |
|
ReadGeoKey | Gets the specified GeoKey data from a TIFF file. | |
|
ReadGeoKeyAsync | Gets the specified GeoKey data from a TIFF stream. | |
|
ReadGeoKeys | Reads all the GeoKey data found in a TIFF file. | |
|
ReadGeoKeysAsync | Reads all the GeoKey data found in a stream. | |
|
ReadLoadResolutions | Examines a page in a file to determine which resolutions it contains. | |
|
ReadLoadResolutionsAsync | Examines a stream to determine which resolutions it contains. | |
|
ReadMarkers | Reads all the metadata markers (COM and APPn) from a file. | |
|
ReadMarkersAsync | Reads all the metadata markers (COM and APPn) from a stream. | |
|
ReadMetadataItems | Reads metadata from the specified file. | |
|
ReadMetadataItemsAsync | Reads metadata from the specified stream. | |
|
ReadStamp | Reads a thumbnail image stored in the image file. | |
|
ReadStampAsync | Reads a thumbnail image stored in an image stream. | |
|
ReadTag | Gets the specified tagged data from a TIFF file. Tags | TIFF |
|
ReadTagAsync | Gets the specified tagged data from a TIFF stream. | |
|
ReadTags | Reads all the tags stored in a TIFF file. | |
|
ReadTagsAsync | Reads all the tags stored in a TIFF file. | |
|
ReadTagsWithOffsets | Reads all the tags stored in a TIFF file, along with the offsets for each tag. | |
|
ReadTagsWithOffsetsAsync | Reads all the tags stored in a TIFF file, along with the offsets for each tag. | |
|
ReadThumbnail | Creates a thumbnail from the specified image file. | |
|
ReadThumbnailAsync | Creates a thumbnail from the specified image stream. | |
|
Save | Saves one or more pages of a RasterImage to a remote URL in any of the supported compressed or uncompressed formats. | |
|
SaveAsync | Saves a RasterImage to a remote URL in any of the supported compressed or uncompressed formats asynchronously. | |
|
SaveCmykPlanes | Saves the pages of an image as a CMYK TIFF or JPEG file. | |
|
SaveCmykPlanesAsync | Saves the pages of an image as a CMYK TIFF or JPEG stream. | |
|
SaveOptions | Saves the options of this RasterCodecs to a disk file. | |
|
SavePsdWithLayers | Saves an image to a PSD file, along with the specified layers. | |
|
SavePsdWithLayersAsync | Saves an image to a PSD file, along with the specified layers. | |
|
SaveStamp | Saves a stamp in an existing file with specific options. | |
|
SaveStampAsync | Saves a stamp in an existing file with specific options. | |
|
SaveXMPMetadata | Saves all XMP metadata from the source XML file to the destination image file. | |
|
SetCodecInformation | Sets information about the specified codec. | |
|
SetCodecsInformation | Sets the information about all of the codecs. | |
|
StartCompress | Initializes the unmanaged memory buffered compression engine. | |
|
StartDecompress | Initializes the buffered decompression engine. | |
|
StartFeedGetInformation | Initializes a file information process in which you control the input stream. | |
|
StartFeedLoad | Initializes a file-load process in which you control the input stream with specific number of pages. | |
|
StartOptimizedLoad | Indicates the beginning of a section of code using the same source file. | |
|
StartOverlay | Indicates which method should be called when an overlay is detected inside a file. | |
|
StartRedirecting | Starts file I/O redirection. | |
|
StopCompress | Cleans up all data variables and buffers allocated by the JPEG or LEAD CMP compression engine. | |
|
StopDecompress | Ends the decompression process and cleans up all the variables and buffers allocated. | |
|
StopFeedGetInformation | Ends a file information process in which you control the input stream. | |
|
StopFeedLoad | Ends a file-load process in which you control the input stream. | |
|
StopOptimizedLoad | Indicates the end of a section of code using the same source file. | |
|
StopOverlay | Restores the previous overlay callback. | |
|
StopRedirecting | Stops file I/O redirection and resets the I/O methods back to their defaults. | |
|
TagsSupported | Checks whether the given file format supports tags | |
|
Transform | Performs a lossless transformation for certain formats. | |
|
UseAsync | Creates the WebClient object used for asynchronous operations. | |
|
WriteComment | Writes a comment to an existing file. | |
|
WriteCommentAsync | Writes a comment to an existing stream. | |
|
WriteComments | Writes one or more comments to an existing file. | |
|
WriteCommentsAsync | Writes one or more comments to an existing stream. | |
|
WriteGeoKey | Writes or changes a GeoKey to an existing file. | |
|
WriteGeoKeyAsync | Writes or changes a GeoKeys to an existing stream. | |
|
WriteGeoKeys | Writes or changes one or more GeoKeys to an existing file. | |
|
WriteGeoKeysAsync | Writes or changes one or more GeoKeys to an existing stream. | |
|
WriteMarker | Writes a marker to an existing file. | |
|
WriteMarkerAsync | Writes a marker to an existing stream. | |
|
WriteMarkers | Writes one or more markers to an existing file. | |
|
WriteMarkersAsync | Writes one or more markers to an existing stream. | |
|
WriteTag | Writes or changes a tag to an existing file. | |
|
WriteTagAsync | Writes or changes a tag to an existing stream. | |
|
WriteTags | Writes or changes one or more tags to an existing file. | |
|
WriteTagsAsync | Writes or changes one or more tags to an existing stream. | |
|
WriteTransformMarker | Controls how the transform markers are used when performing a lossless transformation for certain formats. |
Protected Methods
| Name | Description | |
|---|---|---|
 |
Dispose | Releases all the resources used by this RasterCodecs. |
|
Finalize | This member overrides Finalize. |
Public Properties
| Name | Description | |
|---|---|---|
 |
AsyncWebClient | Gets the WebClient object used for asynchronous operations. |
|
CachedPreloadCodecs | Gets the current setting for the cached preload codecs count. |
|
EventsDispatchMode | Gets or sets a value that specifies the mode used to dispatch LEADTOOLS events. |
|
FastFileInfo | Enables or disables fast file info processing. |
|
FixedPreloadCodecs | Gets the current setting for the fixed preload codecs count. |
|
IgnoreCodecsList | Gets the current ignore codecs list. |
|
IsAsyncBusy | Gets a value that determines whether this RasterCodecs object is currently busy with an asynchronous operation on a URL. |
|
IsFeedLoadDone | Determines if the feed-load process is done. |
|
LoadStatus | Gets a value that allows detection of whether the image was loaded with errors. |
|
LoadThenResize | Gets or sets a value that determine whether this RasterCodecs object should load the image entirely before resizing. |
|
Options | Gets or sets the load and save options for this RasterCodecs. |
|
PreloadCodecsList | Gets the current preload codecs list. |
|
ThrowExceptionsOnInvalidImages | Gets or sets a value indicating whether to throw an exception instead of returning a null reference on certain methods of this RasterCodecs object. |
|
UriOperationBufferSize | Gets or sets the size of the buffer used in URI-based load or information operations. |
|
UriOperationCredentials | Gets or sets authentication information used with URI-based operations |
|
UriOperationProxy | Gets or sets proxy information used with URI-based operations |
Public Events
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
 |
GeoKeyFound | Occurs once for each GeoKey enumerated by the EnumGeoKeys method. | |||||
|
GetInformationAsyncCompleted | Indicates that an asynchronous get information operation has been completed. | |||||
|
LoadAsyncCompleted | Indicates that an asynchronous load operation has been completed. | |||||
|
LoadImage | Occurs during the file load process to provide functionality for manually handling the output image data or monitoring a progress status. Loading | Events | Manual Handling | Monitoring | Image Files | LoadAsync |
|
LoadInformation | Occurs during loading of a file for which LEADTOOLS cannot recognize the format. | |||||
|
LoadPage | Occurs multiple times for each page loaded from an image file. | |||||
|
LoadSvgAsyncCompleted | Indicates that an asynchronous load SVG operation has been completed. | |||||
|
RedirectClose | Replaces the normal LEADTOOLS method for closing a file. | |||||
|
RedirectOpen | Replaces the normal LEADTOOLS method for opening a file. | |||||
|
RedirectRead | Replaces the normal LEADTOOLS method for reading from a file. | |||||
|
RedirectSeek | Replaces the normal LEADTOOLS method for seeking into a file. | |||||
|
RedirectWrite | Replaces the normal LEADTOOLS method for writing to a file. | |||||
|
SaveAsyncCompleted | Indicates that an asynchronous save operation has been completed. | |||||
|
SaveImage | Occurs during the file save process to provide functionality for manually handling the output image data or monitoring a progress status. | |||||
|
SavePage | Occurs once for each page saved to an image file. | |||||
|
TagFound | Occurs during the TIFF tag enumerated by the EnumTags method. |
Public Fields
| Name | Description | |
|---|---|---|
 |
FileMetadataKeyAuthor | The author (file creator) metadata key. |
|
FileMetadataKeyCreateDate | The file creation date (in local time) metadata key. |
|
FileMetadataKeyKeywords | The keywords metadata key. |
|
FileMetadataKeyLastSavedBy | The last saved by metadata key. |
|
FileMetadataKeyMofifiedDate | The file modification date (in local time) metadata key. |
|
FileMetadataKeyRevisionNumber | The revision number metadata key. |
|
FileMetadataKeySubject | The subject metadata key. |
|
FileMetadataKeyTitle | The title metadata key. |
