GrapeCity.Documents.Pdf.MergeDocumentOptions

Class MergeDocumentOptions

Namespace

GrapeCity.Documents.Pdf

Assembly

GcDocs.Pdf.dll

Represents the various options controlling the behavior of the MergeWithDocument(GcPdfDocument, MergeDocumentOptions) method.

public class MergeDocumentOptions

Inheritance

object

MergeDocumentOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

MergeDocumentOptions()

public MergeDocumentOptions()

Properties

CopyArticleThreads

Gets or sets a value indicating whether to copy ArticleThreads.

The default is true.

public bool CopyArticleThreads { get; set; }

Property Value

bool

CopyAssociatedFiles

Gets or sets a value indicating whether to copy AssociatedFiles.

The default is true.

public bool CopyAssociatedFiles { get; set; }

Property Value

bool

CopyDocumentLevelEmbeddedFiles

Gets or sets a value indicating whether to copy files embedded in the source document to the EmbeddedFiles collection.

The default is false.

public bool CopyDocumentLevelEmbeddedFiles { get; set; }

Property Value

bool

CopyFields

Gets or sets a value indicating whether to copy Acroform fields.

The default is true.

public bool CopyFields { get; set; }

Property Value

bool

CopyNamedDestinations

Gets or sets a value indicating whether to copy NamedDestinations. By default this property is false.

Note that if the source document contains destinations with same names as in the target document, then those destinations will be skipped. A more complex logic can be implemented programmatically.

public bool CopyNamedDestinations { get; set; }

Property Value

bool

CopyOptionalContent

Gets or sets a value indicating whether to copy OptionalContent.

The default is true.

public bool CopyOptionalContent { get; set; }

Property Value

bool

DestinationOutlines

Gets or sets the OutlineNodeCollection to which the outlines from the source document linked to the merged pages will be copied.

This can be either the target document's root Outlines collection, or one of its nested nodes' Children collections.

public OutlineNodeCollection DestinationOutlines { get; set; }

Property Value

OutlineNodeCollection

DestinationStructTreeItems

Gets or sets the StructTreeItemCollection to which the structure items from the source document will be copied.

public StructTreeItemCollection DestinationStructTreeItems { get; set; }

Property Value

StructTreeItemCollection

Index

Gets or sets the starting position in the destination document at which the pages of the source document will be inserted.

-1 (the default) indicates that the pages will be added to the end of the document.

public int Index { get; set; }

Property Value

int

MergeStructTree

Gets or sets a value indicating whether to merge structure trees.

The default is false.

public bool MergeStructTree { get; set; }

Property Value

bool

OutlineMergeMode

Gets or sets the outline merge mode.

The default is None (in this mode, outlines from the source document are ignored).

public OutlineMergeMode OutlineMergeMode { get; set; }

Property Value

OutlineMergeMode

PagesRange

Gets or sets the OutputRange object specifying the range of the pages in the source document that should be merged into the destination document.

Null (the default) indicates that all pages will be merged.

public OutputRange PagesRange { get; set; }

Property Value

OutputRange

RemoveDuplicateImages

Gets or sets a value indicating whether to remove duplicate images after merging. If true, the RemoveDuplicateImages() method will be called when the merging is complete.

The default is false.

public bool RemoveDuplicateImages { get; set; }

Property Value

bool