ShapeType enumeration

ShapeType enumeration

Specifies the type of shape in a Microsoft Word document.

Members

NameDescription
IMAGEThe shape is an image.
TEXT_BOXThe 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.
GROUPThe shape is a group shape.
OLE_OBJECTThe shape is an OLE object. You cannot create shapes of this type in the document.
OLE_CONTROLThe shape is an ActiveX control. You cannot create shapes of this type in the document.
NON_PRIMITIVEA 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
ROUND_RECTANGLE
ELLIPSE
DIAMOND
TRIANGLE
RIGHT_TRIANGLE
PARALLELOGRAM
TRAPEZOID
HEXAGON
OCTAGON
PLUS
STAR
ARROW
THICK_ARROW
HOME_PLATE
CUBE
BALLOON
SEAL
ARC
LINE
PLAQUE
CAN
DONUT
TEXT_SIMPLE
TEXT_OCTAGON
TEXT_HEXAGON
TEXT_CURVE
TEXT_WAVE
TEXT_RING
TEXT_ON_CURVE
TEXT_ON_RING
STRAIGHT_CONNECTOR1
BENT_CONNECTOR2
BENT_CONNECTOR3
BENT_CONNECTOR4
BENT_CONNECTOR5
CURVED_CONNECTOR2
CURVED_CONNECTOR3
CURVED_CONNECTOR4
CURVED_CONNECTOR5
CALLOUT1
CALLOUT2
CALLOUT3
ACCENT_CALLOUT1
ACCENT_CALLOUT2
ACCENT_CALLOUT3
BORDER_CALLOUT1
BORDER_CALLOUT2
BORDER_CALLOUT3
ACCENT_BORDER_CALLOUT1
ACCENT_BORDER_CALLOUT2
ACCENT_BORDER_CALLOUT3
RIBBON
RIBBON2
CHEVRON
PENTAGON
NO_SMOKING
SEAL8
SEAL16
SEAL32
WEDGE_RECT_CALLOUT
WEDGE_R_RECT_CALLOUT
WEDGE_ELLIPSE_CALLOUT
WAVE
FOLDED_CORNER
LEFT_ARROW
DOWN_ARROW
UP_ARROW
LEFT_RIGHT_ARROW
UP_DOWN_ARROW
IRREGULAR_SEAL1
IRREGULAR_SEAL2
LIGHTNING_BOLT
HEART
QUAD_ARROW
LEFT_ARROW_CALLOUT
RIGHT_ARROW_CALLOUT
UP_ARROW_CALLOUT
DOWN_ARROW_CALLOUT
LEFT_RIGHT_ARROW_CALLOUT
UP_DOWN_ARROW_CALLOUT
QUAD_ARROW_CALLOUT
BEVEL
LEFT_BRACKET
RIGHT_BRACKET
LEFT_BRACE
RIGHT_BRACE
LEFT_UP_ARROW
BENT_UP_ARROW
BENT_ARROW
SEAL24
STRIPED_RIGHT_ARROW
NOTCHED_RIGHT_ARROW
BLOCK_ARC
SMILEY_FACE
VERTICAL_SCROLL
HORIZONTAL_SCROLL
CIRCULAR_ARROW
CUSTOM_SHAPEThis 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.
UTURN_ARROW
CURVED_RIGHT_ARROW
CURVED_LEFT_ARROW
CURVED_UP_ARROW
CURVED_DOWN_ARROW
CLOUD_CALLOUT
ELLIPSE_RIBBON
ELLIPSE_RIBBON2
FLOW_CHART_PROCESS
FLOW_CHART_DECISION
FLOW_CHART_INPUT_OUTPUT
FLOW_CHART_PREDEFINED_PROCESS
FLOW_CHART_INTERNAL_STORAGE
FLOW_CHART_DOCUMENT
FLOW_CHART_MULTIDOCUMENT
FLOW_CHART_TERMINATOR
FLOW_CHART_PREPARATION
FLOW_CHART_MANUAL_INPUT
FLOW_CHART_MANUAL_OPERATION
FLOW_CHART_CONNECTOR
FLOW_CHART_PUNCHED_CARD
FLOW_CHART_PUNCHED_TAPE
FLOW_CHART_SUMMING_JUNCTION
FLOW_CHART_OR
FLOW_CHART_COLLATE
FLOW_CHART_SORT
FLOW_CHART_EXTRACT
FLOW_CHART_MERGE
FLOW_CHART_OFFLINE_STORAGE
FLOW_CHART_ONLINE_STORAGE
FLOW_CHART_MAGNETIC_TAPE
FLOW_CHART_MAGNETIC_DISK
FLOW_CHART_MAGNETIC_DRUM
FLOW_CHART_DISPLAY
FLOW_CHART_DELAY
TEXT_PLAIN_TEXTWordArt object.
TEXT_STOPWordArt object.
TEXT_TRIANGLEWordArt object.
TEXT_TRIANGLE_INVERTEDWordArt object.
TEXT_CHEVRONWordArt object.
TEXT_CHEVRON_INVERTEDWordArt object.
TEXT_RING_INSIDEWordArt object.
TEXT_RING_OUTSIDEWordArt object.
TEXT_ARCH_UP_CURVEWordArt object.
TEXT_ARCH_DOWN_CURVEWordArt object.
TEXT_CIRCLE_CURVEWordArt object.
TEXT_BUTTON_CURVEWordArt object.
TEXT_ARCH_UP_POURWordArt object.
TEXT_ARCH_DOWN_POURWordArt object.
TEXT_CIRCLE_POURWordArt object.
TEXT_BUTTON_POURWordArt object.
TEXT_CURVE_UPWordArt object.
TEXT_CURVE_DOWNWordArt object.
TEXT_CASCADE_UPWordArt object.
TEXT_CASCADE_DOWNWordArt object.
TEXT_WAVE1WordArt object.
TEXT_WAVE2WordArt object.
TEXT_WAVE3WordArt object.
TEXT_WAVE4WordArt object.
TEXT_INFLATEWordArt object.
TEXT_DEFLATEWordArt object.
TEXT_INFLATE_BOTTOMWordArt object.
TEXT_DEFLATE_BOTTOMWordArt object.
TEXT_INFLATE_TOPWordArt object.
TEXT_DEFLATE_TOPWordArt object.
TEXT_DEFLATE_INFLATEWordArt object.
TEXT_DEFLATE_INFLATE_DEFLATEWordArt object.
TEXT_FADE_RIGHTWordArt object.
TEXT_FADE_LEFTWordArt object.
TEXT_FADE_UPWordArt object.
TEXT_FADE_DOWNWordArt object.
TEXT_SLANT_UPWordArt object.
TEXT_SLANT_DOWNWordArt object.
TEXT_CAN_UPWordArt object.
TEXT_CAN_DOWNWordArt object.
FLOW_CHART_ALTERNATE_PROCESS
FLOW_CHART_OFFPAGE_CONNECTOR
CALLOUT90
ACCENT_CALLOUT90
BORDER_CALLOUT90
ACCENT_BORDER_CALLOUT90
LEFT_RIGHT_UP_ARROW
SUN
MOON
BRACKET_PAIR
BRACE_PAIR
SEAL4
DOUBLE_WAVE
ACTION_BUTTON_BLANK
ACTION_BUTTON_HOME
ACTION_BUTTON_HELP
ACTION_BUTTON_INFORMATION
ACTION_BUTTON_FORWARD_NEXT
ACTION_BUTTON_BACK_PREVIOUS
ACTION_BUTTON_END
ACTION_BUTTON_BEGINNING
ACTION_BUTTON_RETURN
ACTION_BUTTON_DOCUMENT
ACTION_BUTTON_SOUND
ACTION_BUTTON_MOVIE
SINGLE_CORNER_SNIPPEDSnip single corner rectangle object.
TOP_CORNERS_SNIPPEDSnip same side corner rectangle.
DIAGONAL_CORNERS_SNIPPEDSnip diagonal corner rectangle.
TOP_CORNERS_ONE_ROUNDED_ONE_SNIPPEDSnip and round single corner rectangle.
SINGLE_CORNER_ROUNDEDRound single corner rectangle.
TOP_CORNERS_ROUNDEDRound same side corner rectangle.
DIAGONAL_CORNERS_ROUNDEDRound diagonal corner rectangle.
HEPTAGONHeptagon.
CLOUDCloud.
SEAL6Six-pointed star.
SEAL7Seven-pointed star.
SEAL10Ten-pointed star.
SEAL12Twelve-pointed star.
SWOOSH_ARROWSwoosh arrow.
TEARDROPTeardrop.
SQUARE_TABSSquare tabs.
PLAQUE_TABSPlaque tabs.
PIEPie.
WEDGE_PIEWedge pie.
INVERSE_LINEInverse line.
MATH_PLUSMath plus.
MATH_MINUSMath minus.
MATH_MULTIPLYMath multiply.
MATH_DIVIDEMath divide.
MATH_EQUALMath equal.
MATH_NOT_EQUALMath not equal.
NON_ISOSCELES_TRAPEZOIDNon-isosceles trapezoid.
LEFT_RIGHT_CIRCULAR_ARROWLeft-right circular arrow.
LEFT_RIGHT_RIBBONLeft-right ribbon.
LEFT_CIRCULAR_ARROWLeft circular arrow.
FRAMEFrame.
HALF_FRAMEHalf frame.
FUNNELFunnel.
GEAR6Six-tooth gear.
GEAR9Nine-tooth gear.
DECAGONDecagon.
DODECAGONDodecagon.
DIAGONAL_STRIPEDiagonal stripe.
CORNERCorner.
CORNER_TABSCorner tabs.
CHORDChord.
CHART_PLUSChart plus.
CHART_STARChart star.
CHART_XChart X.
MIN_VALUEReserved for the system use.

Examples

Shows how to insert a shape with an image from the local file system into a document.

doc = aw.Document()

# The "Shape" class's public constructor will create a shape with "ShapeMarkupLanguage.VML" markup type.
# If you need to create a shape of a non-primitive type, such as SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped,
# TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, or DiagonalCornersRounded,
# please use DocumentBuilder.insert_shape.
shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.IMAGE)
shape.image_data.set_image(IMAGE_DIR + "Windows MetaFile.wmf")
shape.width = 100
shape.height = 100

doc.first_section.body.first_paragraph.append_child(shape)

doc.save(ARTIFACTS_DIR + "Image.from_file.docx")

Shows how Aspose.Words identify shapes.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.insert_shape(aw.drawing.ShapeType.HEPTAGON, aw.drawing.RelativeHorizontalPosition.PAGE, 0,
    aw.drawing.RelativeVerticalPosition.PAGE, 0, 0, 0, aw.drawing.WrapType.NONE)

builder.insert_shape(aw.drawing.ShapeType.CLOUD, aw.drawing.RelativeHorizontalPosition.RIGHT_MARGIN, 0,
    aw.drawing.RelativeVerticalPosition.PAGE, 0, 0, 0, aw.drawing.WrapType.NONE)

builder.insert_shape(aw.drawing.ShapeType.MATH_PLUS, aw.drawing.RelativeHorizontalPosition.RIGHT_MARGIN, 0,
    aw.drawing.RelativeVerticalPosition.PAGE, 0, 0, 0, aw.drawing.WrapType.NONE)

# To correct identify shape types you need to work with shapes as DML.
save_options = aw.saving.OoxmlSaveOptions(aw.SaveFormat.DOCX)

# "Strict" or "Transitional" compliance allows to save shape as DML.
save_options.compliance = aw.saving.OoxmlCompliance.ISO29500_2008_TRANSITIONAL

doc.save(ARTIFACTS_DIR + "Shape.shape_types.docx", save_options)
doc = aw.Document(ARTIFACTS_DIR + "Shape.shape_types.docx")

shapes = [node.as_shape() for node in doc.get_child_nodes(aw.NodeType.SHAPE, True)]

for shape in shapes:
    print(shape.shape_type)

See Also

ShapeMarkupLanguage enumeration SignatureLine class