LEADTOOLS Image File Support (Leadtools.Codecs assembly)

DeleteTagAsync Method

Show in webframe







A Leadtools.ILeadStream containing the image data of the file from which to delete the tag.
The 1-based index of the page from which the tag will be deleted. Use -1 to delete the tag from the last page. Use 1 to delete the tag from the first page.
The ID of the tag in the TIFF file. The tag IDs are between 0 and 65535.
Deletes a tag from a stream, if the file supports tags (TIFF or Exif).
Syntax
public IAsyncAction DeleteTagAsync( 
   ILeadStream stream,
   int pageNumber,
   int id
)
'Declaration
 
Public Function DeleteTagAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer, _
   ByVal id As Integer _
) As IAsyncAction
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim id As Integer
Dim value As IAsyncAction
 
value = instance.DeleteTagAsync(stream, pageNumber, id)
public IAsyncAction DeleteTagAsync( 
   ILeadStream stream,
   int pageNumber,
   int id
)

            

            
 function Leadtools.Codecs.RasterCodecs.DeleteTagAsync( 
   stream ,
   pageNumber ,
   id 
)
public:
IAsyncAction^ DeleteTagAsync( 
   ILeadStream^ stream,
   int pageNumber,
   int id
) 

Parameters

stream
A Leadtools.ILeadStream containing the image data of the file from which to delete the tag.
pageNumber
The 1-based index of the page from which the tag will be deleted. Use -1 to delete the tag from the last page. Use 1 to delete the tag from the first page.
id
The ID of the tag in the TIFF file. The tag IDs are between 0 and 65535.

Return Value

An asynchronous delete operation on a RasterCodecs object.
Remarks

If you want to delete the tag from a particular IFD in the file, set RasterCodecs.Options.Tiff.Save.UseImageFileDirectoryOffset to true, and set RasterCodecs.Options.Tiff.Save.ImageFileDirectoryOffset to the IFD in question. This method will delete tags only from the main IFDs that make up an image. Some TIFF tags are themselves SubIFDs. You can delete tags from such SubIFDs by using RasterCodecs.Options.Tiff.Save.UseImageFileDirectoryOffset and RasterCodecs.Options.Tiff.Save.ImageFileDirectoryOffset specifying the IFD as above.

Notes:

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. Recompression is not performed under any of these cases.

Example
For an example, refer to DeleteTag.
Requirements

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Implementing TIFF Comments and Tags

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.