TextElement Class

Pageflex Document Action API

previous page next page

Pageflex Document Action API TextElement Class

The TextElement class represents a document element containing a sequence of text characters with identical style properties.

Syntax

Visual Basic

Managed C++

public class TextElement : Element, ICharacter, ICopyFit, IRangeElement, IVariableElement

Public Class TextElement _
	Inherits Element _
	Implements ICharacter, ICopyFit, IRangeElement, IVariableElement

public ref class TextElement : public Element, ICharacter, ICopyFit, IRangeElement, IVariableElement

Members

All Members	Constructors	Methods	Properties	Fields	Events
Public Protected		Instance Static		Declared Inherited

Icon	Member	Description
	BaselineShift	Gets or sets the distance to offset the baseline for a sequence of characters or other tokens.
	Bold	Gets or sets whether to use a bold member of the assigned font family to compose text.
	CopyFitFontSize	Gets the actual font size after copyfitting.
	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.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	FirstChildElement	Gets this element's first child Element in the document tree. (Inherited from Element.)
	FontFamily	Gets or sets the name of the font family used to compose text.
	FontSize	Gets or sets the font size used to compose text.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsVisible	trueTruetrue if this element and all ancestor elements are Visible, and falseFalsefalse otherwise. (Inherited from Element.)
	Italic	Gets or sets whether to use the italic member of the assigned font family to compose text.
	Language	Gets or sets the Language used to hyphenate and spell-check text.
	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.)
	ParentElement	Gets this element's parent Element in the document tree. (Inherited from Element.)
	Range	Gets a Range representing the text contained by this element.
	TextColor	Gets or sets the name of the Color used for drawing text.
	TextTint	Gets or sets the saturation level of the text color.
	ToString()	(Inherited from Object.)
	Underline	Gets or sets whether text should be underlined.
	Variable	Gets or sets the name of the Variable associated with this Element
	Visible	Gets or sets whether this element should be visible or hidden. (Inherited from Element.)

Remarks

The parent element of a text element is always a Paragraph.

Inheritance Hierarchy

Object
	PFObject
		Element
			TextElement

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)

previous page start next page