←Select platform

Save(string,AnnContainer,AnnCodecsFormat,int,AnnCodecsSavePageMode) Method

Summary

Saves the annotation objects to a disk file.

Syntax

C#
VB
C++
  
Public Overloads Sub Save( _ 
   ByVal fileName As String, _ 
   ByVal container As Leadtools.Annotations.AnnContainer, _ 
   ByVal format As Leadtools.Annotations.AnnCodecsFormat, _ 
   ByVal page As Integer, _ 
   ByVal pageMode As Leadtools.Annotations.AnnCodecsSavePageMode _ 
)  

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.

Remarks

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 (Deprecated).

Example

For an example, refer to AnnCodecs.

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations Assembly