Aspose::Words::Drawing Namespace Reference

Namespaces

 Charts
 
 
 Ole
 

Classes

class  Fill
 Defines a fill for a shape. More...
 
class  GroupShape
 Represents a group of shapes in a document. More...
 
class  ImageData
 Defines an image for a shape. More...
 
class  ImageSize
 Contains information about image size and resolution. More...
 
class  OleFormat
 Provides access to the data of an OLE object or ActiveX control. More...
 
class  OlePackage
 Allows to access OLE Package properties. More...
 
class  Shape
 Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture. More...
 
class  ShapeBase
 Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture. More...
 
class  Stroke
 Defines a stroke for a shape. More...
 
class  TextBox
 Defines attributes that specify how a text is displayed inside a shape. More...
 
class  TextPath
 Defines the text and formatting of the text path (of a WordArt object). More...
 

Enumerations

enum  ArrowLength { ArrowLength::Short = 0, ArrowLength::Medium = 1, ArrowLength::Long = 2, ArrowLength::Default = static_cast<int32_t>(Short) }
 Length of the arrow at the end of a line. More...
 
enum  ArrowType {
  ArrowType::None = 0, ArrowType::Arrow = 1, ArrowType::Stealth = 2, ArrowType::Diamond = 3,
  ArrowType::Oval = 4, ArrowType::Open = 5, ArrowType::Default = static_cast<int32_t>(None)
}
 Specifies the type of an arrow at a line end. More...
 
enum  ArrowWidth { ArrowWidth::Narrow = 0, ArrowWidth::Medium = 1, ArrowWidth::Wide = 2, ArrowWidth::Default = static_cast<int32_t>(Narrow) }
 Width of the arrow at the end of a line. More...
 
enum  DashStyle {
  DashStyle::Solid = 0, DashStyle::ShortDash = 1, DashStyle::ShortDot = 2, DashStyle::ShortDashDot = 3,
  DashStyle::ShortDashDotDot = 4, DashStyle::Dot = 5, DashStyle::Dash = 6, DashStyle::LongDash = 7,
  DashStyle::DashDot = 8, DashStyle::LongDashDot = 9, DashStyle::LongDashDotDot = 10, DashStyle::Default = static_cast<int32_t>(Solid)
}
 Dashed line style. More...
 
enum  EndCap { EndCap::Round = 0, EndCap::Square = 1, EndCap::Flat = 2, EndCap::Default = static_cast<int32_t>(Flat) }
 Specifies line cap style. More...
 
enum  FlipOrientation { FlipOrientation::None = 0x00, FlipOrientation::Horizontal = 0x01, FlipOrientation::Vertical = 0x02, FlipOrientation::Both = 0x03 }
 Possible values for the orientation of a shape. More...
 
enum  HorizontalAlignment {
  HorizontalAlignment::None = 0, HorizontalAlignment::Default = static_cast<int32_t>(None), HorizontalAlignment::Left = 1, HorizontalAlignment::Center = 2,
  HorizontalAlignment::Right = 3, HorizontalAlignment::Inside = 4, HorizontalAlignment::Outside = 5
}
 Specifies horizontal alignment of a floating shape, text frame or floating table. More...
 
enum  ImageType {
  ImageType::NoImage = 0, ImageType::Unknown = 1, ImageType::Emf = 2, ImageType::Wmf = 3,
  ImageType::Pict = 4, ImageType::Jpeg = 5, ImageType::Png = 6, ImageType::Bmp = 7
}
 Specifies the type (format) of an image in a Microsoft Word document. More...
 
enum  JoinStyle { JoinStyle::Bevel = 0, JoinStyle::Miter = 1, JoinStyle::Round = 2 }
 Line join style. More...
 
enum  LayoutFlow {
  LayoutFlow::Horizontal = 0, LayoutFlow::TopToBottomIdeographic = 1, LayoutFlow::BottomToTop = 2, LayoutFlow::TopToBottom = 3,
  LayoutFlow::HorizontalIdeographic = 4, LayoutFlow::Vertical = 5
}
 Determines the flow of the text layout in a textbox. More...
 
enum  RelativeHorizontalPosition {
  RelativeHorizontalPosition::Margin = 0, RelativeHorizontalPosition::Page = 1, RelativeHorizontalPosition::Column = 2, RelativeHorizontalPosition::Character = 3,
  RelativeHorizontalPosition::LeftMargin = 4, RelativeHorizontalPosition::RightMargin = 5, RelativeHorizontalPosition::InsideMargin = 6, RelativeHorizontalPosition::OutsideMargin = 7,
  RelativeHorizontalPosition::Default = static_cast<int32_t>(Column)
}
 Specifies to what the horizontal position of a shape or text frame is relative. More...
 
enum  RelativeVerticalPosition {
  RelativeVerticalPosition::Margin = 0, RelativeVerticalPosition::Page = 1, RelativeVerticalPosition::Paragraph = 2, RelativeVerticalPosition::Line = 3,
  RelativeVerticalPosition::TopMargin = 4, RelativeVerticalPosition::BottomMargin = 5, RelativeVerticalPosition::InsideMargin = 6, RelativeVerticalPosition::OutsideMargin = 7,
  RelativeVerticalPosition::TableDefault = static_cast<int32_t>(Margin), RelativeVerticalPosition::TextFrameDefault = static_cast<int32_t>(Paragraph)
}
 Specifies to what the vertical position of a shape or text frame is relative. More...
 
enum  ShapeLineStyle {
  ShapeLineStyle::Single = 0, ShapeLineStyle::Double = 1, ShapeLineStyle::ThickThin = 2, ShapeLineStyle::ThinThick = 3,
  ShapeLineStyle::Triple = 4, ShapeLineStyle::Default = static_cast<int32_t>(Single)
}
 Specifies the compound line style of a Aspose::Words::Drawing::Shape. More...
 
enum  ShapeMarkupLanguage : uint8_t { ShapeMarkupLanguage::Dml, ShapeMarkupLanguage::Vml }
 Specifies Markup language used for the shape. More...
 
enum  ShapeType {
  ShapeType::Image = 75, ShapeType::TextBox = 202, ShapeType::Group = -1, ShapeType::OleObject = -2,
  ShapeType::OleControl = 201, ShapeType::NonPrimitive = 0, ShapeType::Rectangle = 1, ShapeType::RoundRectangle = 2,
  ShapeType::Ellipse = 3, ShapeType::Diamond = 4, ShapeType::Triangle = 5, ShapeType::RightTriangle = 6,
  ShapeType::Parallelogram = 7, ShapeType::Trapezoid = 8, ShapeType::Hexagon = 9, ShapeType::Octagon = 10,
  ShapeType::Plus = 11, ShapeType::Star = 12, ShapeType::Arrow = 13, ShapeType::ThickArrow = 14,
  ShapeType::HomePlate = 15, ShapeType::Cube = 16, ShapeType::Balloon = 17, ShapeType::Seal = 18,
  ShapeType::Arc = 19, ShapeType::Line = 20, ShapeType::Plaque = 21, ShapeType::Can = 22,
  ShapeType::Donut = 23, ShapeType::TextSimple = 24, ShapeType::TextOctagon = 25, ShapeType::TextHexagon = 26,
  ShapeType::TextCurve = 27, ShapeType::TextWave = 28, ShapeType::TextRing = 29, ShapeType::TextOnCurve = 30,
  ShapeType::TextOnRing = 31, ShapeType::StraightConnector1 = 32, ShapeType::BentConnector2 = 33, ShapeType::BentConnector3 = 34,
  ShapeType::BentConnector4 = 35, ShapeType::BentConnector5 = 36, ShapeType::CurvedConnector2 = 37, ShapeType::CurvedConnector3 = 38,
  ShapeType::CurvedConnector4 = 39, ShapeType::CurvedConnector5 = 40, ShapeType::Callout1 = 41, ShapeType::Callout2 = 42,
  ShapeType::Callout3 = 43, ShapeType::AccentCallout1 = 44, ShapeType::AccentCallout2 = 45, ShapeType::AccentCallout3 = 46,
  ShapeType::BorderCallout1 = 47, ShapeType::BorderCallout2 = 48, ShapeType::BorderCallout3 = 49, ShapeType::AccentBorderCallout1 = 50,
  ShapeType::AccentBorderCallout2 = 51, ShapeType::AccentBorderCallout3 = 52, ShapeType::Ribbon = 53, ShapeType::Ribbon2 = 54,
  ShapeType::Chevron = 55, ShapeType::Pentagon = 56, ShapeType::NoSmoking = 57, ShapeType::Seal8 = 58,
  ShapeType::Seal16 = 59, ShapeType::Seal32 = 60, ShapeType::WedgeRectCallout = 61, ShapeType::WedgeRRectCallout = 62,
  ShapeType::WedgeEllipseCallout = 63, ShapeType::Wave = 64, ShapeType::FoldedCorner = 65, ShapeType::LeftArrow = 66,
  ShapeType::DownArrow = 67, ShapeType::UpArrow = 68, ShapeType::LeftRightArrow = 69, ShapeType::UpDownArrow = 70,
  ShapeType::IrregularSeal1 = 71, ShapeType::IrregularSeal2 = 72, ShapeType::LightningBolt = 73, ShapeType::Heart = 74,
  ShapeType::QuadArrow = 76, ShapeType::LeftArrowCallout = 77, ShapeType::RightArrowCallout = 78, ShapeType::UpArrowCallout = 79,
  ShapeType::DownArrowCallout = 80, ShapeType::LeftRightArrowCallout = 81, ShapeType::UpDownArrowCallout = 82, ShapeType::QuadArrowCallout = 83,
  ShapeType::Bevel = 84, ShapeType::LeftBracket = 85, ShapeType::RightBracket = 86, ShapeType::LeftBrace = 87,
  ShapeType::RightBrace = 88, ShapeType::LeftUpArrow = 89, ShapeType::BentUpArrow = 90, ShapeType::BentArrow = 91,
  ShapeType::Seal24 = 92, ShapeType::StripedRightArrow = 93, ShapeType::NotchedRightArrow = 94, ShapeType::BlockArc = 95,
  ShapeType::SmileyFace = 96, ShapeType::VerticalScroll = 97, ShapeType::HorizontalScroll = 98, ShapeType::CircularArrow = 99,
  ShapeType::CustomShape = 100, ShapeType::UturnArrow = 101, ShapeType::CurvedRightArrow = 102, ShapeType::CurvedLeftArrow = 103,
  ShapeType::CurvedUpArrow = 104, ShapeType::CurvedDownArrow = 105, ShapeType::CloudCallout = 106, ShapeType::EllipseRibbon = 107,
  ShapeType::EllipseRibbon2 = 108, ShapeType::FlowChartProcess = 109, ShapeType::FlowChartDecision = 110, ShapeType::FlowChartInputOutput = 111,
  ShapeType::FlowChartPredefinedProcess = 112, ShapeType::FlowChartInternalStorage = 113, ShapeType::FlowChartDocument = 114, ShapeType::FlowChartMultidocument = 115,
  ShapeType::FlowChartTerminator = 116, ShapeType::FlowChartPreparation = 117, ShapeType::FlowChartManualInput = 118, ShapeType::FlowChartManualOperation = 119,
  ShapeType::FlowChartConnector = 120, ShapeType::FlowChartPunchedCard = 121, ShapeType::FlowChartPunchedTape = 122, ShapeType::FlowChartSummingJunction = 123,
  ShapeType::FlowChartOr = 124, ShapeType::FlowChartCollate = 125, ShapeType::FlowChartSort = 126, ShapeType::FlowChartExtract = 127,
  ShapeType::FlowChartMerge = 128, ShapeType::FlowChartOfflineStorage = 129, ShapeType::FlowChartOnlineStorage = 130, ShapeType::FlowChartMagneticTape = 131,
  ShapeType::FlowChartMagneticDisk = 132, ShapeType::FlowChartMagneticDrum = 133, ShapeType::FlowChartDisplay = 134, ShapeType::FlowChartDelay = 135,
  ShapeType::TextPlainText = 136, ShapeType::TextStop = 137, ShapeType::TextTriangle = 138, ShapeType::TextTriangleInverted = 139,
  ShapeType::TextChevron = 140, ShapeType::TextChevronInverted = 141, ShapeType::TextRingInside = 142, ShapeType::TextRingOutside = 143,
  ShapeType::TextArchUpCurve = 144, ShapeType::TextArchDownCurve = 145, ShapeType::TextCircleCurve = 146, ShapeType::TextButtonCurve = 147,
  ShapeType::TextArchUpPour = 148, ShapeType::TextArchDownPour = 149, ShapeType::TextCirclePour = 150, ShapeType::TextButtonPour = 151,
  ShapeType::TextCurveUp = 152, ShapeType::TextCurveDown = 153, ShapeType::TextCascadeUp = 154, ShapeType::TextCascadeDown = 155,
  ShapeType::TextWave1 = 156, ShapeType::TextWave2 = 157, ShapeType::TextWave3 = 158, ShapeType::TextWave4 = 159,
  ShapeType::TextInflate = 160, ShapeType::TextDeflate = 161, ShapeType::TextInflateBottom = 162, ShapeType::TextDeflateBottom = 163,
  ShapeType::TextInflateTop = 164, ShapeType::TextDeflateTop = 165, ShapeType::TextDeflateInflate = 166, ShapeType::TextDeflateInflateDeflate = 167,
  ShapeType::TextFadeRight = 168, ShapeType::TextFadeLeft = 169, ShapeType::TextFadeUp = 170, ShapeType::TextFadeDown = 171,
  ShapeType::TextSlantUp = 172, ShapeType::TextSlantDown = 173, ShapeType::TextCanUp = 174, ShapeType::TextCanDown = 175,
  ShapeType::FlowChartAlternateProcess = 176, ShapeType::FlowChartOffpageConnector = 177, ShapeType::Callout90 = 178, ShapeType::AccentCallout90 = 179,
  ShapeType::BorderCallout90 = 180, ShapeType::AccentBorderCallout90 = 181, ShapeType::LeftRightUpArrow = 182, ShapeType::Sun = 183,
  ShapeType::Moon = 184, ShapeType::BracketPair = 185, ShapeType::BracePair = 186, ShapeType::Seal4 = 187,
  ShapeType::DoubleWave = 188, ShapeType::ActionButtonBlank = 189, ShapeType::ActionButtonHome = 190, ShapeType::ActionButtonHelp = 191,
  ShapeType::ActionButtonInformation = 192, ShapeType::ActionButtonForwardNext = 193, ShapeType::ActionButtonBackPrevious = 194, ShapeType::ActionButtonEnd = 195,
  ShapeType::ActionButtonBeginning = 196, ShapeType::ActionButtonReturn = 197, ShapeType::ActionButtonDocument = 198, ShapeType::ActionButtonSound = 199,
  ShapeType::ActionButtonMovie = 200, ShapeType::SingleCornerSnipped = 203, ShapeType::TopCornersSnipped = 204, ShapeType::DiagonalCornersSnipped = 205,
  ShapeType::TopCornersOneRoundedOneSnipped = 206, ShapeType::SingleCornerRounded = 207, ShapeType::TopCornersRounded = 208, ShapeType::DiagonalCornersRounded = 209,
  ShapeType::MinValue = static_cast<int32_t>(OleObject)
}
 Specifies the type of shape in a Microsoft Word document. More...
 
enum  TextBoxWrapMode { TextBoxWrapMode::Square = 0, TextBoxWrapMode::None = 2 }
 Specifies how text wraps inside a shape. More...
 
enum  TextPathAlignment {
  TextPathAlignment::Stretch = 0, TextPathAlignment::Center = 1, TextPathAlignment::Left = 2, TextPathAlignment::Right = 3,
  TextPathAlignment::LetterJustify = 4, TextPathAlignment::WordJustify = 5
}
 WordArt alignment. More...
 
enum  VerticalAlignment {
  VerticalAlignment::None = 0, VerticalAlignment::Top = 1, VerticalAlignment::Center = 2, VerticalAlignment::Bottom = 3,
  VerticalAlignment::Inside = 4, VerticalAlignment::Outside = 5, VerticalAlignment::Inline = -1, VerticalAlignment::Default = static_cast<int32_t>(None)
}
 Specifies vertical alignment of a floating shape, text frame or a floating table. More...
 
enum  WrapSide {
  WrapSide::Both = 0, WrapSide::Left = 1, WrapSide::Right = 2, WrapSide::Largest = 3,
  WrapSide::Default = static_cast<int32_t>(Both)
}
 Specifies what side(s) of the shape or picture the text wraps around. More...
 
enum  WrapType {
  WrapType::None = 3, WrapType::Inline = 0, WrapType::TopBottom = 1, WrapType::Square = 2,
  WrapType::Tight = 4, WrapType::Through = 5
}
 Specifies how text is wrapped around a shape or picture. More...
 

Detailed Description

The Aspose.Words.Drawing namespace provides classes that allow to create and modify drawing objects.

All drawing objects in in Microsoft Word documents are represented by instances of the Aspose::Words::Drawing::Shape and Aspose::Words::Drawing::GroupShape classes. An object of the Aspose::Words::Drawing::Shape class is a node in a document and can represent a picture, textbox, AutoShape or an OLE object.

The classes in this namespace support the latest (Word 2007 - 2013 DrawingML) and the earlier (pre Word 2007 - Office Art) shapes.

Enumeration Type Documentation

◆ ArrowLength

Length of the arrow at the end of a line.

See also
Aspose::Words::Drawing::Stroke::get_StartArrowLength, Aspose::Words::Drawing::Stroke::get_EndArrowLength
Enumerator
Short 
Medium 
Long 
Default 

Same as Aspose::Words::Drawing::ArrowLength::Short.

◆ ArrowType

Specifies the type of an arrow at a line end.

See also
Aspose::Words::Drawing::Stroke::get_StartArrowType, Aspose::Words::Drawing::Stroke::get_EndArrowType
Enumerator
None 

The line does not have an arrow at the end.

Arrow 

The arrow is a solid triangle.

Stealth 

The arrow is a "stealth" arrow.

Diamond 

The line end is a solid diamond.

Oval 

The line end is a solid oval.

Open 

The arrow is an open arrow.

Default 

Same as Aspose::Words::Drawing::ArrowType::None.

◆ ArrowWidth

Width of the arrow at the end of a line.

See also
Aspose::Words::Drawing::Stroke::get_StartArrowWidth, Aspose::Words::Drawing::Stroke::get_EndArrowWidth
Enumerator
Narrow 
Medium 
Wide 
Default 

Same as Aspose::Words::Drawing::ArrowWidth::Narrow.

◆ DashStyle

Dashed line style.

See also
Aspose::Words::Drawing::Stroke::get_DashStyle
Enumerator
Solid 

Solid (continuous) pen.

ShortDash 

System dash style.

ShortDot 

System dash style.

ShortDashDot 

System dash style.

ShortDashDotDot 

System dash style.

Dot 

Square dot style.

Dash 

Dash style.

LongDash 

Long dash style.

DashDot 

Dash short dash.

LongDashDot 

Long dash short dash.

LongDashDotDot 

Long dash short dash short dash.

Default 

Same as Aspose::Words::Drawing::DashStyle::Solid.

◆ EndCap

Specifies line cap style.

See also
Aspose::Words::Drawing::Stroke::get_EndCap
Enumerator
Round 

Rounded ends.

Square 

Square protrudes by half line width.

Flat 

Line ends at end point.

Default 

Default value is Aspose::Words::Drawing::EndCap::Flat.

◆ FlipOrientation

Possible values for the orientation of a shape.

See also
Aspose::Words::Drawing::ShapeBase::get_FlipOrientation
Enumerator
None 

Coordinates are not flipped.

Horizontal 

Flip along the y-axis, reversing the x-coordinates.

Vertical 

Flip along the x-axis, reversing the y-coordinates.

Both 

Flip along both the y- and x-axis.

◆ HorizontalAlignment

Specifies horizontal alignment of a floating shape, text frame or floating table.

See also
Aspose::Words::Drawing::ShapeBase::get_HorizontalAlignment
Enumerator
None 

The object is explicitly positioned, usually using its Left property.

Default 

Same as Aspose::Words::Drawing::HorizontalAlignment::None.

Left 

Specifies that the object shall be left aligned to the horizontal alignment base.

Center 

Specifies that the object shall be centered with respect to the horizontal alignment base.

Right 

Specifies that the object shall be right aligned to the horizontal alignment base.

Inside 

Specifies that the object shall be inside of the horizontal alignment base.

Outside 

Specifies that the object shall be outside of the horizontal alignment base.

◆ ImageType

Specifies the type (format) of an image in a Microsoft Word document.

See also
Aspose::Words::Drawing::ImageData::get_ImageType
Enumerator
NoImage 

The is no image data.

Unknown 

An unknown image type or image type that cannot be directly stored inside a Microsoft Word document.

Emf 

Windows Enhanced Metafile.

Wmf 

Windows Metafile.

Pict 

Macintosh PICT. An existing image will be preserved in a document, but inserting new PICT images into a document is not supported.

Jpeg 

JPEG JFIF.

Png 

Portable Network Graphics.

Bmp 

Windows Bitmap.

◆ JoinStyle

Line join style.

See also
Aspose::Words::Drawing::Stroke::get_JoinStyle
Enumerator
Bevel 

Join edges by a straight line.

Miter 

Extend edges until they join.

Round 

Draw an arc between the two edges.

◆ LayoutFlow

Determines the flow of the text layout in a textbox.

See also
Aspose::Words::Drawing::TextBox::get_LayoutFlow
Enumerator
Horizontal 

Text is displayed horizontally.

TopToBottomIdeographic 

Ideographic text is displayed vertically.

BottomToTop 

Text is displayed vertically.

TopToBottom 

Text is displayed vertically.

HorizontalIdeographic 

Ideographic text is displayed horizontally.

Vertical 

Text is displayed vertically.

◆ RelativeHorizontalPosition

Specifies to what the horizontal position of a shape or text frame is relative.

See also
Aspose::Words::Drawing::ShapeBase::get_RelativeHorizontalPosition
Enumerator
Margin 

Specifies that the horizontal positioning shall be relative to the page margins.

Page 

The object is positioned relative to the left edge of the page.

Column 

The object is positioned relative to the left side of the column.

Character 

The object is positioned relative to the left side of the paragraph.

LeftMargin 

Specifies that the horizontal positioning shall be relative to the left margin of the page.

RightMargin 

Specifies that the horizontal positioning shall be relative to the right margin of the page.

InsideMargin 

Specifies that the horizontal positioning shall be relative to the inside margin of the current page (the left margin on odd pages, right on even pages).

OutsideMargin 

Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages).

Default 

Default value is Aspose::Words::Drawing::RelativeHorizontalPosition::Column.

◆ RelativeVerticalPosition

Specifies to what the vertical position of a shape or text frame is relative.

See also
Aspose::Words::Drawing::ShapeBase::get_RelativeVerticalPosition
Enumerator
Margin 

Specifies that the vertical positioning shall be relative to the page margins.

Page 

The object is positioned relative to the top edge of the page.

Paragraph 

The object is positioned relative to the top of the paragraph that contains the anchor.

Line 

Undocumented.

TopMargin 

Specifies that the vertical positioning shall be relative to the top margin of the current page.

BottomMargin 

Specifies that the vertical positioning shall be relative to the bottom margin of the current page.

InsideMargin 

Specifies that the vertical positioning shall be relative to the inside margin of the current page.

OutsideMargin 

Specifies that the vertical positioning shall be relative to the outside margin of the current page.

TableDefault 

Default value is Aspose::Words::Drawing::RelativeVerticalPosition::Margin.

TextFrameDefault 

Default value is Aspose::Words::Drawing::RelativeVerticalPosition::Paragraph.

◆ ShapeLineStyle

Specifies the compound line style of a Aspose::Words::Drawing::Shape.

See also
Aspose::Words::Drawing::Stroke::get_LineStyle
Enumerator
Single 

Single line.

Double 

Double lines of equal width.

ThickThin 

Double lines, one thick, one thin.

ThinThick 

Double lines, one thin, one thick.

Triple 

Three lines, thin, thick, thin.

Default 

Default value is Aspose::Words::Drawing::ShapeLineStyle::Single.

◆ ShapeMarkupLanguage

Specifies Markup language used for the shape.

Enumerator
Dml 

Drawing Markup Language is used to define the shape.

This is the new standard for drawing for Office Open XML which has appeared first in ECMA-376 1st edition (2006), first appeared in MS Word 2007.

Vml 

Vector Markup Language is used to define the shape.

A deprecated format included in Office Open XML for legacy reasons only.

◆ ShapeType

Specifies the type of shape in a Microsoft Word document.

See also
Aspose::Words::Drawing::ShapeBase::get_ShapeType
Enumerator
Image 

The shape is an image.

TextBox 

The shape is a textbox. Note that shapes of many other types can also have text inside them too. A shape does not have to have this type to contain text.

Group 

The shape is a group shape.

OleObject 

The shape is an OLE object.

You cannot create shapes of this type in the document.

OleControl 

The shape is an ActiveX control.

You cannot create shapes of this type in the document.

NonPrimitive 

A shape drawn by user and consisting of multiple segments and/or vertices (curve, freeform or scribble).

You cannot create shapes of this type in the document.

Rectangle 
RoundRectangle 
Ellipse 
Diamond 
Triangle 
RightTriangle 
Parallelogram 
Trapezoid 
Hexagon 
Octagon 
Plus 
Star 
Arrow 
ThickArrow 
HomePlate 
Cube 
Balloon 
Seal 
Arc 
Line 
Plaque 
Can 
Donut 
TextSimple 
TextOctagon 
TextHexagon 
TextCurve 
TextWave 
TextRing 
TextOnCurve 
TextOnRing 
StraightConnector1 
BentConnector2 
BentConnector3 
BentConnector4 
BentConnector5 
CurvedConnector2 
CurvedConnector3 
CurvedConnector4 
CurvedConnector5 
Callout1 
Callout2 
Callout3 
AccentCallout1 
AccentCallout2 
AccentCallout3 
BorderCallout1 
BorderCallout2 
BorderCallout3 
AccentBorderCallout1 
AccentBorderCallout2 
AccentBorderCallout3 
Ribbon 
Ribbon2 
Chevron 
Pentagon 
NoSmoking 
Seal8 
Seal16 
Seal32 
WedgeRectCallout 
WedgeRRectCallout 
WedgeEllipseCallout 
Wave 
FoldedCorner 
LeftArrow 
DownArrow 
UpArrow 
LeftRightArrow 
UpDownArrow 
IrregularSeal1 
IrregularSeal2 
LightningBolt 
Heart 
QuadArrow 
LeftArrowCallout 
RightArrowCallout 
UpArrowCallout 
DownArrowCallout 
LeftRightArrowCallout 
UpDownArrowCallout 
QuadArrowCallout 
Bevel 
LeftBracket 
RightBracket 
LeftBrace 
RightBrace 
LeftUpArrow 
BentUpArrow 
BentArrow 
Seal24 
StripedRightArrow 
NotchedRightArrow 
BlockArc 
SmileyFace 
VerticalScroll 
HorizontalScroll 
CircularArrow 
CustomShape 

This shape type seems to be set for shapes that are not part of the standard set of the auto shapes in Microsoft Word. For example, if you insert a new auto shape from ClipArt.

You cannot create shapes of this type in the document.

UturnArrow 
CurvedRightArrow 
CurvedLeftArrow 
CurvedUpArrow 
CurvedDownArrow 
CloudCallout 
EllipseRibbon 
EllipseRibbon2 
FlowChartProcess 
FlowChartDecision 
FlowChartInputOutput 
FlowChartPredefinedProcess 
FlowChartInternalStorage 
FlowChartDocument 
FlowChartMultidocument 
FlowChartTerminator 
FlowChartPreparation 
FlowChartManualInput 
FlowChartManualOperation 
FlowChartConnector 
FlowChartPunchedCard 
FlowChartPunchedTape 
FlowChartSummingJunction 
FlowChartOr 
FlowChartCollate 
FlowChartSort 
FlowChartExtract 
FlowChartMerge 
FlowChartOfflineStorage 
FlowChartOnlineStorage 
FlowChartMagneticTape 
FlowChartMagneticDisk 
FlowChartMagneticDrum 
FlowChartDisplay 
FlowChartDelay 
TextPlainText 

WordArt object.

TextStop 

WordArt object.

TextTriangle 

WordArt object.

TextTriangleInverted 

WordArt object.

TextChevron 

WordArt object.

TextChevronInverted 

WordArt object.

TextRingInside 

WordArt object.

TextRingOutside 

WordArt object.

TextArchUpCurve 

WordArt object.

TextArchDownCurve 

WordArt object.

TextCircleCurve 

WordArt object.

TextButtonCurve 

WordArt object.

TextArchUpPour 

WordArt object.

TextArchDownPour 

WordArt object.

TextCirclePour 

WordArt object.

TextButtonPour 

WordArt object.

TextCurveUp 

WordArt object.

TextCurveDown 

WordArt object.

TextCascadeUp 

WordArt object.

TextCascadeDown 

WordArt object.

TextWave1 

WordArt object.

TextWave2 

WordArt object.

TextWave3 

WordArt object.

TextWave4 

WordArt object.

TextInflate 

WordArt object.

TextDeflate 

WordArt object.

TextInflateBottom 

WordArt object.

TextDeflateBottom 

WordArt object.

TextInflateTop 

WordArt object.

TextDeflateTop 

WordArt object.

TextDeflateInflate 

WordArt object.

TextDeflateInflateDeflate 

WordArt object.

TextFadeRight 

WordArt object.

TextFadeLeft 

WordArt object.

TextFadeUp 

WordArt object.

TextFadeDown 

WordArt object.

TextSlantUp 

WordArt object.

TextSlantDown 

WordArt object.

TextCanUp 

WordArt object.

TextCanDown 

WordArt object.

FlowChartAlternateProcess 
FlowChartOffpageConnector 
Callout90 
AccentCallout90 
BorderCallout90 
AccentBorderCallout90 
LeftRightUpArrow 
Sun 
Moon 
BracketPair 
BracePair 
Seal4 
DoubleWave 
ActionButtonBlank 
ActionButtonHome 
ActionButtonHelp 
ActionButtonInformation 
ActionButtonForwardNext 
ActionButtonBackPrevious 
ActionButtonEnd 
ActionButtonBeginning 
ActionButtonReturn 
ActionButtonDocument 
ActionButtonSound 
ActionButtonMovie 
SingleCornerSnipped 

Snip single corner rectangle object.

Applicable only for DML shapes.

TopCornersSnipped 

Snip same side corner rectangle.

Applicable only for DML shapes.

DiagonalCornersSnipped 

Snip diagonal corner rectangle.

Applicable only for DML shapes.

TopCornersOneRoundedOneSnipped 

Snip and round single corner rectangle.

Applicable only for DML shapes.

SingleCornerRounded 

Round single corner rectangle.

Applicable only for DML shapes.

TopCornersRounded 

Round same side corner rectangle.

Applicable only for DML shapes.

DiagonalCornersRounded 

Round diagonal corner rectangle.

Applicable only for DML shapes.

MinValue 

Reserved for the system use.

◆ TextBoxWrapMode

Specifies how text wraps inside a shape.

Enumerator
Square 

Text wraps inside a shape.

None 

Text does not wrap inside a shape.

◆ TextPathAlignment

WordArt alignment.

See also
Aspose::Words::Drawing::TextPath::get_TextPathAlignment
Enumerator
Stretch 

Stretch each line of text to fit width.

Center 

Center text on width.

Left 

Left justify.

Right 

Right justify.

LetterJustify 

Spread letters out to fit width.

WordJustify 

Spread words out to fit width.

◆ VerticalAlignment

Specifies vertical alignment of a floating shape, text frame or a floating table.

See also
Aspose::Words::Drawing::ShapeBase::get_VerticalAlignment
Enumerator
None 

The object is explicitly positioned, usually using its Top property.

Top 

Specifies that the object shall be at the top of the vertical alignment base.

Center 

Specifies that the object shall be centered with respect to the vertical alignment base.

Bottom 

Specifies that the object shall be at the bottom of the vertical alignment base.

Inside 

Specifies that the object shall be inside of the horizontal alignment base.

Outside 

Specifies that the object shall be outside of the vertical alignment base.

Inline 

Not documented. Seems to be a possible value for floating paragraphs and tables.

Default 

Same as Aspose::Words::Drawing::VerticalAlignment::None.

◆ WrapSide

Specifies what side(s) of the shape or picture the text wraps around.

See also
Aspose::Words::Drawing::ShapeBase::get_WrapSide
Enumerator
Both 

The document text wraps on both sides of the shape.

Left 

The document text wraps on the left side of the shape only. There is a text free area on the right of the shape.

Right 

The document text wraps on the right side of the shape only. There is a text free area on the left side of the shape.

Largest 

The document text wraps on the side of the shape that is farthest from the page margin, leaving text free area on the other side of the shape.

Default 

Default value is Aspose::Words::Drawing::WrapSide::Both.

◆ WrapType

Specifies how text is wrapped around a shape or picture.

See also
Aspose::Words::Drawing::ShapeBase::get_WrapType
Enumerator
None 

No text wrapping around the shape. The shape is placed behind or in front of text.

Inline 

The shape remains on the same layer as text and treated as a character.

TopBottom 

The text stops at the top of the shape and restarts on the line below the shape.

Square 

Wraps text around all sides of the square bounding box of the shape.

Tight 

Wraps tightly around the edges of the shape, instead of wrapping around the bounding box.

Through 

Same as Tight, but wraps inside any parts of the shape that are open.