SaveToTag(AnnContainer,int,bool) Method

Summary

Saves the annotation objects in a container to a TIFF tag.

Syntax

C++

public RasterTagMetadata SaveToTag( 
   AnnContainer container, 
   int pageNumber, 
   bool saveToWang 
)

Public Function SaveToTag( _ 
   ByVal container As Leadtools.Annotations.Core.AnnContainer, _ 
   ByVal pageNumber As Integer _ 
   ByVal saveToWang As Boolean _ 
) As Leadtools.RasterTagMetadata

public:  
   RasterTagMetadata^ SaveToTag( 
      AnnContainer^ container, 
      Int32 pageNumber, 
      bool saveToWang 
   )

Parameters

container
The AnnContainer containing the objects to be saved.

pageNumber 1-based index of the page for where the annotations should be saved.

saveToWang
A value that specifies the format used when creating the tag. If true it is a Wang tag, otherwise it is a LEAD tag.

Return Value

An Leadtools.RasterTagMetadata object that can be saved into a TIFF file.

Remarks

This method will return a Leadtools.RasterTagMetadata object with Id = AnnotationTiff (the value 80A4 in hexadecimal).

After calling this method, you can save the Leadtools.RasterTagMetadata object returned into an existing TIFF file by calling the >RasterCodecs.WriteTag method or one of the RasterCodecs.WriteTags methods.

This method can return null (Nothing in VB) if you try to save unsupported objects to certain formats (for example, if you try to save an AnnAudioObject to a Wang format).

Requirements

Target Platforms