Document Class

Pageflex Document Action API

Pageflex Document Action API Document Class
Namespaces > Pageflex.Scripting > Document
The Document class represents a Pageflex document, and also the root of that document's tree of elements.
Syntax
C# Visual Basic Managed C++
public class Document : Element, ISearchable
Public Class Document _
	Inherits Element _
	Implements ISearchable
public ref class Document : public Element, ISearchable
Members
All Members Constructors Methods Properties Fields Events



Icon Member Description
BeginUndoSection(String)
Begins the bracketing of a set of operations which will potentially be undone in one operation.
ColorsUsed
Gets the names of all Colors used by this element and its descendants.
CompositionVersion
Gets the composition version used to format this document.
CreateColorCmyk(String, Double, Double, Double, Double, Boolean)
Creates a new CMYK Color with the specified name and values.
CreateColorRgb(String, UInt32, UInt32, UInt32, Boolean)
Creates a new RGB Color with the specified name and values.
Delete()
Deletes this element and also deletes any descendant elements.
(Inherited from Element.)
Duplicate()
Creates a copy of the element and inserts it as the element's next sibling.
(Inherited from Element.)
EnableFormatting
Gets or sets whether document formatting is enabled.
EndUndoSection()
Ends the bracketing started by a BeginUndoSection(String) call and saves the set of operations on the undo stack.
Equals(Object) (Inherited from Object.)
Finalize() (Inherited from Object.)
FindElement(String)
Finds the Element with the specified name which descends from this element.
FindText(String, Boolean, Boolean)
Finds all instances of the specified text in the document.
FirstChildElement
Gets this element's first child Element in the document tree.
(Inherited from Element.)
FontsUsed
Gets the names of all font families used by this element and its descendants.
GetColor(String)
Returns the Color with the specified name defined for the document.
GetHashCode() (Inherited from Object.)
GetPage(UInt32)
Gets the Page with the specified page index.
GetParagraphStyle(String)
Returns the ParagraphStyle with the specified name defined for the document.
GetType() (Inherited from Object.)
Images
Gets all Image elements which are descendants of this element.
IsVisible
trueTruetrue if this element and all ancestor elements are Visible, and falseFalsefalse otherwise.
(Inherited from Element.)
JobMediaUsed
Gets the names of all job media used in the document.
MemberwiseClone() (Inherited from Object.)
MoveBefore(Element, Element)
Moves this Element to a different place in the document tree.
(Inherited from Element.)
NextElementInTree
Gets the next Element in a depth-first traversal of the document tree.
(Inherited from Element.)
NextNonDescendantElementInTree
Gets the next Element (in a depth-first traversal of the document tree) which is not a descendant of this element.
(Inherited from Element.)
NextSiblingElement
Gets this element's next sibling Element in the document tree.
(Inherited from Element.)
OverflowingTextContainers
Gets all ITextContainer elements whose content has overflowed.
PageCount
Gets the number of pages in the document.
PageHeight
Gets or sets the height of all pages in the document.
PageWidth
Gets or sets the width of all pages in the document.
ParagraphStylesUsed
Gets the names of all ParagraphStyles used by this element and its descendants.
ParentElement
Gets this element's parent Element in the document tree.
(Inherited from Element.)
Redo()
Performs again the most recently undone operation or undo section.
RemoveVariables(Boolean)
Removes any Variable assigned to the element, and also removes any variables assigned to descendant elements.
TextStreams
Gets all text streams in the document.
ToString() (Inherited from Object.)
Undo()
Reverts the document to its state before the most recent operation or undo section.
UndoEnabled
Gets or sets whether Undo() and Redo() are enabled.
UpdateTablesOfContents()
Updates all tables of contents in the document.
VariablesUsed
Gets the names of all Variables used by this element and its descendants.
Visible
Gets or sets whether this element should be visible or hidden.
(Inherited from Element.)
Inheritance Hierarchy
Object
PFObject
  Element
    Document

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)