Shape Class

Pageflex Document Action API

Pageflex Document Action API Shape Class
Namespaces > Pageflex.Scripting > Shape
The Shape class represents a graphical document element. Subclasses represent specific shape types, such as a rectangle, text frame, or image.
Syntax
C# Visual Basic Managed C++
public class Shape : Element
Public Class Shape _
	Inherits Element
public ref class Shape : public Element
Members
All Members Constructors Methods Properties Fields Events



Icon Member Description
ShapeNew()
Initializes a new instance of the Shape class.
Angle
Gets or sets the angle of the shape relative to its containing object.
BoundsInContainer
Gets the shape's bounding box relative to its Container.
BoundsInPage
Gets the shape's bounding box relative to its containing page.
ConstrainSelectionAndEditing
Gets or sets whether selection and editing of the shape should be prevented during an online editing session.
ConstrainSizeAndPosition
Gets or sets whether changes to the shape's size and position should be prevented during an online editing session.
Container
Gets the IShapeContainer shape or page which geometrically contains this shape.
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.)
GetHashCode() (Inherited from Object.)
GetType() (Inherited from Object.)
Height
Gets or sets the height of the shape.
IsVisible
trueTruetrue if this element and all ancestor elements are Visible, and falseFalsefalse otherwise.
(Inherited from Element.)
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.)
NextShapeToDraw
Gets or sets the next Shape in the Container's draw order.
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.)
SendToBack()
Makes this shape first in its Container's draw order.
SendToFront()
Makes this shape last in its Container's draw order.
SuppressPrinting
Gets or sets whether the shape should be included or suppressed when generating output.
ToString() (Inherited from Object.)
UiClass
Gets or sets the shape's user interface class, supporting custom user interfaces in online editing sessions.
Visible
Gets or sets whether this element should be visible or hidden.
(Inherited from Element.)
Width
Gets or sets the width of the shape.
X
Gets or sets the horizontical (x) position of the shape relative to its containing shape or page.
Y
Gets or sets the vertical (y) position of the shape relative to its containing shape or page.
Inheritance Hierarchy
Object
PFObject
  Element
    Shape
      AreaTemplate
      AreaTemplateBezier
      AreaTemplateOval
      Bezier
      Group
      HorizontalGroup
      Image
      Oval
      Rectangle
      TextBox
      TextContainerBezier
      TextContainerOval
      TextFrame
      TextPathBezier
      VerticalGroup

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)