Save(String,AnnContainer,AnnCodecsFormat,Int32,AnnCodecsSavePageMode) Method

Visual Basic
C#
Objective-C
Java
C++

public void Save( 
   string fileName,
   AnnContainer container,
   AnnCodecsFormat format,
   int page,
   AnnCodecsSavePageMode pageMode
)

'Declaration
 
Public Overloads Sub Save( _
   ByVal fileName As String, _
   ByVal container As AnnContainer, _
   ByVal format As AnnCodecsFormat, _
   ByVal page As Integer, _
   ByVal pageMode As AnnCodecsSavePageMode _
)

'Usage
 
Dim instance As AnnCodecs
Dim fileName As String
Dim container As AnnContainer
Dim format As AnnCodecsFormat
Dim page As Integer
Dim pageMode As AnnCodecsSavePageMode
 
instance.Save(fileName, container, format, page, pageMode)

public:
void Save( 
   String^ fileName,
   AnnContainer^ container,
   AnnCodecsFormat format,
   int page,
   AnnCodecsSavePageMode pageMode
)

Parameters

fileName: The output file name.
container: An AnnContainer containing the objects to be saved.
format: An AnnCodecsFormat value that specifies the annotation format to use when saving.
page: 1-based index of the page to be saved.
pageMode: A value that indicates how to handle the page when saving to a multi-page file.

pageMode can be one of the following:

Mode	Description
AnnCodecsSavePageMode.Overwrite	fileName will be overwritten if it exists and all previous information will be lost. Value of page must be 1 or -1 (for appending the objects as last page).
AnnCodecsSavePageMode.Insert	fileName must be a valid file with valid annotation pages. Value of page must be between 1 and total number of pages in the file. A value of -1 will append the objects as last page.
AnnCodecsSavePageMode.Replace	fileName must be a valid file with valid annotation pages. Value of page must be between 1 and total number of pages in the file.

To save multiple containers to a multi-page file using one method, use Save(string, AnnContainer[], AnnCodecsFormat).

For more information, refer to Annotation Files.

For an example, refer to AnnCodecs.

Target Platforms

Reference

AnnCodecs Class
AnnCodecs Members
Overload List