Shape Class

In This Topic

Represents a shape.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class Shape 
   Inherits Container

'Usage
 
Dim instance As Shape

public class Shape : Container

Remarks

Currently, a Shape can only be a Rectangle or a TextBox.

Inheritance Hierarchy

System.Object
   Xceed.Document.NET.DocumentElement
      Xceed.Document.NET.Container
         Xceed.Document.NET.Shape

Public Properties

	Name	Description
	Charts	Gets the collection of Charts in this Container. (Inherited from Xceed.Document.NET.Container)
	Comments	(Inherited from Xceed.Document.NET.Container)
	DistanceFromTextBottom	Gets or sets the distance of the text from the bottom of the Shape.
	DistanceFromTextLeft	Gets or sets the distance of the text from the left of the Shape.
	DistanceFromTextRight	Gets or sets the distance of the text from the right of the Shape.
	DistanceFromTextTop	Gets or sets the distance of the text from the top of the Shape.
	FillColor	Gets or sets the color used to fill this Shape.
	FlipH	Gets or sets if this Shape is horizontally flipped.
	FlipV	Gets or sets if this Shape is vertically flipped.
	Height	Gets or sets the height of this Shape (in points).
	HorizontalAlignment	Gets or sets the text horizontal alignment for this Shape.
	HorizontalOffset	Gets or sets the text horizontal offset of this Shape relative to the element identified in the HorizontalOffsetAlignmentFrom property.
	HorizontalOffsetAlignmentFrom	Gets or sets the element from which the HorizontalOffset is calculated.
	Hyperlinks	Gets the collection of Hyperlinks in this Container. (Inherited from Xceed.Document.NET.Container)
	IsTextAutoFit	Gets or sets if this Shape auto adjusts its size to fit the contained text.
	IsTextWrap	Gets or sets if the text inside this Shape will wrap.
	Lists	Gets the collection of Lists in this Container. (Inherited from Xceed.Document.NET.Container)
	OutlineColor	Gets or sets the outline color of this Shape.
	OutlineDash	Gets or sets the style of this Shape's outline dash.
	OutlineWidth	Gets or sets the width of this Shape's outline (in points).
	PackagePart	Gets or sets the PackagePart for this element. (Inherited from Xceed.Document.NET.DocumentElement)
	Paragraphs	Gets the collection of Paragraphs in this Container. (Inherited from Xceed.Document.NET.Container)
	ParagraphsDeepSearch	(Inherited from Xceed.Document.NET.Container)
	Pictures	Gets the collection of Pictures in this Container. (Inherited from Xceed.Document.NET.Container)
	PresetShape	Gets or sets the type of this Shape.
	Sections	Gets the collection of Sections after reading the xml of this Container. (Inherited from Xceed.Document.NET.Container)
	Shapes	Gets the collection of Shapes in this Container. (Inherited from Xceed.Document.NET.Container)
	Tables	Gets the collection of Tables in this Container. (Inherited from Xceed.Document.NET.Container)
	TextBoxes	Gets the collection of TextBoxes in this Container. (Inherited from Xceed.Document.NET.Container)
	TextMarginBottom	Gets or sets the margin between the text and the bottom side of this shape (in points).
	TextMarginLeft	Gets or sets the margin between the text and the left side of this Shape (in points).
	TextMarginRight	Gets or sets the margin between the text and the right side of this Shape (in points).
	TextMarginTop	Gets or sets the margin between the text and the top side of this Shape (in points).
	TextVerticalAlignment	Gets or sets the vertical alignment of the text inside this Shape.
	VerticalAlignment	Gets or sets the text vertical alignment for this Shape.
	VerticalOffset	Gets or sets the text vertical offset of this Shape relative to the element identified in the VerticalOffsetAlignmentFrom property.
	VerticalOffsetAlignmentFrom	Gets or sets the element from which the VerticalOffset is calculated.
	Width	Gets or sets the width of this Shape (in points).
	WrapPolygon	Gets or sets the list of points to use to define the polygon inside this Shape where no text can be drawn.
	WrapStyle	Gets or sets the text wrapping style.
	WrapTextPosition	Gets or sets the text wrapping position.
	Xml	Gets or sets the XML for this element. (Inherited from Xceed.Document.NET.DocumentElement)

Top

Public Methods

	Name	Description
	ClearBookmarks	Removes all the Bookmarks from this Container. (Inherited from Xceed.Document.NET.Container)
	FindAll	Overloaded. Retrieves all the indexes in this Container where the provided search value is found. (Inherited from Xceed.Document.NET.Container)
	FindUniqueByPattern	Finds all unique instances of the provided Regex pattern. (Inherited from Xceed.Document.NET.Container)
	GetBookmarks	Retrieves the list of Bookmarks found in this Container. (Inherited from Xceed.Document.NET.Container)
	GetSections	Reads the xml of the Container to create a list of Sections. (Inherited from Xceed.Document.NET.Container)
	InsertAtBookmark	Inserts the provided text to this Container, at the provided bookmark position, using the specified formatting. (Inherited from Xceed.Document.NET.Container)
	InsertBookmark	Inserts a Bookmark to this Container. (Inherited from Xceed.Document.NET.Container)
	InsertContent	Inserts content in this Container. (Inherited from Xceed.Document.NET.Container)
	InsertEquation	Inserts an equation to this Container. (Inherited from Xceed.Document.NET.Container)
	InsertList	Overloaded. Inserts a List in this Container. (Inherited from Xceed.Document.NET.Container)
	InsertParagraph	Overloaded. Inserts a Paragraph at a specific location in this Container, using the provided text, and optionally track this change. (Inherited from Xceed.Document.NET.Container)
	InsertSection	Overloaded. Inserts a Section to this Container. (Inherited from Xceed.Document.NET.Container)
	InsertSectionPageBreak	Inserts a section page break to this Container, and optionally track this change. (Inherited from Xceed.Document.NET.Container)
	InsertTable	Overloaded. Inserts a Table of a specific size in this Container. (Inherited from Xceed.Document.NET.Container)
	Remove	Removes the current Shape (or TextBox) from the document.
	RemoveBookmark	Removes the specified Bookmark from the Container. (Inherited from Xceed.Document.NET.Container)
	RemoveParagraph	Removes a Paragraph from this Container. (Inherited from Xceed.Document.NET.Container)
	RemoveParagraphAt	Removes the Paragraph found at a specific location in the Container. (Inherited from Xceed.Document.NET.Container)
	RemoveText	Removes all the Text between a startingTag and an endingTag, even when those tags are located in different Paragraphs. (Inherited from Xceed.Document.NET.Container)
	RemoveTextInGivenFormat	Removes all text occurences that match the provided format. (Inherited from Xceed.Document.NET.Container)
	ReplaceAtBookmark	Replaces the text at the specified Bookmark in this Container. (Inherited from Xceed.Document.NET.Container)
	ReplacePicture	Targets a Picture from a specific Paragraph in the Container & replaces it with a new Picture. (Inherited from Xceed.Document.NET.Container)
	ReplaceText	Overloaded. Replaces all instances of a string with another string. (Inherited from Xceed.Document.NET.Container)
	ReplaceTextWithHTML	Replaces all instances of a string with HTML content. (Inherited from Xceed.Document.NET.Container)
	ReplaceTextWithObject	Replaces all instances of a string with a DocumentElement. (Inherited from Xceed.Document.NET.Container)
	SetDirection	Sets the Direction of the content of this Container. (Inherited from Xceed.Document.NET.Container)
	ValidateBookmarks	Can be used to validate Bookmarks. (Inherited from Xceed.Document.NET.Container)

Top

Protected Methods

	Name	Description
	AddElementInXml	Overridden.

Top

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

Shape Members
Xceed.Document.NET Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference