aspose.diagram

Use these types to programmatically manipulate Visio shapes, pages, controls, and layout properties. The reference lists each class, enum, and their members with usage details.

Classes

ClassDescription
AbstractInterruptMonitorMonitor for interruption requests in all time-consuming operations.
ActDefines custom command names that appear on an object’s shortcut menu and specifies the actions that the commands take.
ActCollectionAct collection.
ActiveXControlRepresents the ActiveX control.
ActiveXControlBaseRepresents the ActiveX control.
AlignIndicates the alignment of a shape with respect to the guide or guide point to which the shape is glued. The Align eleme
AlignmentSpecifies the tab alignment.
AnnotationContains elements that contain information about comments inserted into a document page.
AnnotationCollectionAnnotation collection.
ArcToContains the x- and y-coordinates and bow of a circular arc represented respectively by the X, Y, and A elements.
ArcToCollectionArcTo collection.
ArrowSizeSpecifies the size of the arrowhead of the line.
AutoLinkComparisonDefines a rule that compares a column in the parent DataRecordset element with a shape data item from the last successfu
AutoSpaceOptionsRepresents autospace options.
BevelRepresents a bevel of a shape
BevelLightingTypeSpecifies the type of shadow for a shape.
BevelMaterialTypeSpecifies the type of shadow for a shape.
BevelTypeSpecifies the type of shadow for a shape.
BoolValueBoolean value.
BulletDetermines the bullet style.
CalculateOptionsRepresents options for calculation.
CalendarDetermines the calendar that is used for custom properties, text fields, and element formulas.
CaseDetermines the case of a shape’s text.
CharContains the formatting attributes for the shape’s text, such as font, color, text style, case, position relative to the
CharCollectionChar collection.
CheckBoxActiveXControlRepresents a CheckBox ActiveX control.
ColorEntryContains a color table entry. Each color table entry specifies a standard color that is available for application to obj
ColorEntryCollectionContains the document’s color table. Each document contains a single color table, which lists the 24 standard colors tha
ColorValueRepresents color value
ComboBoxActiveXControlRepresents a ComboBox ActiveX control.
CommandButtonActiveXControlRepresents a command button.
CompoundTypeSpecifies the size of the arrowhead of the line.
ConFixedCodeDetermines when a connector reroutes.
ConLineJumpCodeDetermines whether a connector jumps when two connectors cross.
ConLineJumpDirXDetermines the line jump direction for line jumps occurring on a horizontal segment of a dynamic connector.
ConLineJumpDirYDetermines the line jump direction for line jumps occurring on a vertical segment of a dynamic connector.
ConLineJumpStyleDetermines the line jump style for line jumps on a dynamic connector.
ConLineRouteExtDetermines the appearance of a connector.
ConTypeSpecifies the type of behavior the x or y-coordinate of the control handle exhibits after the handle is moved.
ConnectRepresents a connection between two shapes in a drawing, such as a line and a box in an organization chart.
ConnectCollectionConnect collection.
ConnectionContains elements for one connection point defined for the shape.
ConnectionABCDThe ConnectionABCD element is an obsolete version of the Connection element and exists only for backward compatibility.
ConnectionABCDCollectionConnectionABCD collection.
ConnectionCollectionConnection collection.
ConnectorRuleRepresents connector rule between two shapes with a connector,Including which connection point of which shape it starts
ContainerPropertiesContainerProperties for shape.
ControlContains elements for the x- and y-coordinates of each control handle defined for a shape, and elements that specify the
ControlCollectionControl collection.
CoordinateAbstract class for the x- and y-coordinates.
CoordinateCollectionCoordinate collection.
CpMarks the beginning of a character properties run that is formatted according to the corresponding Char element. The run
CustomPropCustomProp structure.
CustomPropCollectionCustomProps collection.
CustomValueValue of property.
DataColumnDefines how a data column appears in the External Data window in the Visio user interface and qualifies the data in the
DataColumnCollectionDataColumn collection.
DataConnectionAbstracts communication between one or more DataRecordset elements and a non-XML data source.
DataConnectionCollectionDataConnection collection.
DataRecordSetStores, formats, refreshes, and exposes data queried from a database in Microsoft Visio.
DataRecordSetCollectionDataRecordSet collection.
DateValueDate and time value.
DiagramRoot element of Visio objects hierarchy.
DiagramExceptionBase class for all Aspose.Diagram exceptions
DiagramSaveOptionsCan be used to specify additional options when saving a diagram into Visio (VDX\VSX) format. At the moment provides only
DisplayModeWhen it is contained in a Group element, the DisplayMode element specifies how a group shape and its members are display
DisplayModeSmartTagDefDisplayMode element determines whether the smart tag appears when the user pauses the mouse over the tag, when the shape
DocPropsContains elements that control the document’s preview quality, scope, and output format.
DocumentPropertiesContains document property elements such as the document’s title, author, and so on.
DocumentSettingsContains elements that specify document settings.
DocumentSheetSpecifies a document’s ShapeSheet structure.
DoubleValueDouble value
DrawingResizeTypeDetermines whether the drawing page resizes automatically to fit the diagram.
DrawingScaleTypeSpecifies the type of drawing scale to use for a page.
DrawingSizeTypeSpecifies the drawing size of a page.
DrawioSaveOptionsRepresents the save options for drawio format.
DynFeedbackSpecifies the type of visual feedback provided to users when they drag a connector. When the mouse button is released, t
EllipseContains elements specifying the x- and y-coordinates of the ellipse’s center point and two points on the ellipse.
EllipseCollectionEllipse collection.
EllipticalArcToContains elements that specify information about an elliptical arc.
EllipticalArcToCollectionEllipticalArcTo collection.
EventContains elements that specify formulas that control shape events.
EventItemEncapsulates an event code. An EventItem element can trigger two kinds of actions: it can run an add-on, or it can send
EventItemCollectionEventItem collection.
FieldContains elements that specify functions and formulas inserted in the shape’s text.
FieldCollectionField collection.
FileFontSourceRepresents the single TrueType font file stored in the file system.
FileFormatInfoContains data returned by FileFormatUtil file format detection methods.
FileFormatUtilProvides utility methods for converting file format enums to strings or file extensions and back.
FillContains the current fill formatting values for the shape and the shape’s drop shadow, including pattern, foreground col
FldIndicates a text-field insertion point for the corresponding Field element.
FloatPointNumCollectionContains a collection of doubling point numbers
FolderFontSourceRepresents the folder that contains TrueType font files.
FontContains information about a font.
FontCollectionContains a collection of Font elements.
FontConfigsSpecifies font settings
FontSourceBaseThis is an abstract base class for the classes that allow the user to specify various font sources
ForeignContains elements specifying the width and height of an object from another program used in a Microsoft Visio document.
ForeignDataContains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap,
FormatTxtAbstract class for formatting of text
FormatTxtCollectionFormatTxt collection which contains the text of a shape.
GeomContains elements that specify the coordinates of the vertices for the lines and arcs that make up the shape. If the sha
GeomCollectionGeom collection.
GlowEffectThis class specifies a glow effect, in which a color blurred outline is added outside the edges of the object.
GlueTypeSpecifies whether dynamic (shape-to-shape) glue is allowed when connecting to a shape.
GradientFillRepresents the gradient fill.
GradientStopRepresents the gradient stop.
GradientStopCollectionRepresents the gradient stop collection.
GridDensitySpecifies the type of horizontal/vertical grid to use for a page.
GroupContains elements that control how you add shapes to a group, move members of a group, and select groups.
HTMLSaveOptionsAllows to specify additional options when rendering diagram pages to HTML.
HeaderFooterContains elements for a document’s header and footer.
HeaderFooterFontSpecifies the font used for the header and footer text.
HelpContains elements specifying the Shape element’s Help file topic and copyright information.
HorzAlignSpecifies the horizontal alignment of text in the shape’s text block.
HyperlinkContains elements for creating multiple jumps between a shape or drawing page and another drawing page, another file, or
HyperlinkCollectionHyperlink collection.
ImageContains the gamma, brightness, contrast, blur, sharpen, denoise, and transparency values for a bitmap.
ImageActiveXControlRepresents the image control.
ImageSaveOptionsAllows to specify additional options when rendering diagram pages to images.
IndividualFontConfigsFont configs for each Diagram object.
InfiniteLineContains elements specifying the x- and y-coordinates of two points on an infinite line. The X and Y elements specify th
InfiniteLineCollectionInfiniteLine collection.
IntValueInteger value
InterruptMonitorRepresents all operator about the interrupt.
IssueRepresents a single validation issue in the document.
IssueCollectionIssue collection.
IssueTargetDepending on the target of the parent validation issue, specifies either the page, or both the page and the shape, that
LabelActiveXControlRepresents the label ActiveX control.
LayerContains elements that define a single layer and its properties for a page.
LayerCollectionLayer collection.
LayerMemContains the LayerMember element, which specifies each layer to which the shape is assigned.
LayoutContains elements that control shape placement and connector routing settings.
LayoutOptionsUsed to specify style and additional options of layout of shapes to perform Re-Layout of page(pages).
LicenseProvides methods to license the component.
LineContains elements specifying general positioning information about a shape.
LineAdjustFromSpecifies which dynamic connectors to space apart if they route on top of each other.
LineAdjustToSpecifies which dynamic connectors to line up on top of one another if they route on top of each other.
LineJumpCodeDetermines the dynamic connectors to which you want to add jumps.
LineJumpStyleSpecifies the line jump style for all connectors on the drawing page that don’t have a local line jump style.
LinePatternSpecifies the line pattern of the shape.
LineRouteExtSpecifies the default appearance for all connectors on a page.
LineToContains x- and y-coordinates of the ending vertex of a straight line segment. These coordinates are contained in the X
LineToCollectionLineTo collection.
ListBoxActiveXControlRepresents a ListBox ActiveX control.
LoadFilterRepresents the filter that provides options for loading data when loading diagram from template. User may specify the fi
LoadOptionsAllows to specify additional options when loading a diagram into a Diagram object.
LocalizeFontSpecifies whether the shape text should be localized (translated into another language).
MarginSpecifies the margin.
MasterContains elements that define a master for the document. A master is a shape on a stencil that you use repeatedly to cre
MasterCollectionMaster collection.
MasterShortcutSpecifies a master shortcut defined in the document.
MasterShortcutCollectionMasterShortcut collection.
MemoryFontSourceRepresents the single TrueType font file stored in memory.
MeteredProvides methods to set metered key.
MilestoneHelperMilestoneHelper to set property of milestone shape.
MiscContains various elements of shapes and groups, such as those that control selection highlighting and visibility.
MoveToContains the x- and y-coordinates of the first vertex of a shape, or contains the x- and y-coordinates of the first vert
MoveToCollectionMoveTo collection.
NURBSToContains the x- and y-coordinates, position of the second to last knot, position of the last weight, position of the fir
NURBSToCollectionNURBSTo collection.
ObjTypeSpecifies whether objects are placeable or routable in diagrams when you use Microsoft Visio to lay out shapes on the dr
ObjectKindIndicates the type of text field.
OutputFormatSpecifies the output format for a drawing.
PageContains elements that define a page in the document.
PageCollectionPage collection.
PageEndSavingArgsInfo for a page ends saving process.
PageLayoutContains cells that control the page layout settings for shapes and connectors, such as spacing between all shapes on th
PageLineJumpDirXSpecifies the direction of line jumps on horizontal segments of dynamic connectors on the drawing page for which you hav
PageLineJumpDirYSpecifies the direction of line jumps on vertical dynamic connectors on the drawing page for which you haven’t applied a
PagePropsContains cells that control page attributes, such as the page width, height, and scale.
PageSavingArgsInfo for a page saving process.
PageSheetContains elements that define the page sheet for a Page or Master element.
PageSizeContains information about page size for the generated images.
PageStartSavingArgsInfo for a page starts saving process.
ParaContains the paragraph formatting elements for the shape’s text, such as indents, line spacing, bullets, and horizontal
ParaCollectionPara collection.
PdfBookmarkEntry
PdfEncryptionDetailsContains details for a pdf encryption.
PdfSaveOptionsAllows to specify additional options when rendering diagram pages to PDF.
PlaceDepthFor a drawing that is laid out automatically, specifies the method by which the drawing is analyzed before creating the
PlaceFlipSpecifies how placeable shapes flip and/or rotate on a page when shapes are laid out using the Lay Out Shapes command in
PlaceStyleSpecifies how shapes are placed on the page when shapes are laid out when a user selects Lay Out Shapes (Shape menu).
PolylineToContains x- and y-coordinates of the last point of a polyline and a polyline formula. The coordinates are specified in t
PolylineToCollectionPolylineTo collection.
PosSpecifies the position of the shape’s text relative to the baseline.
PpSpecifies the beginning of a paragraph properties run. The run is defined to the end of the text or until the next
PreviewScopeSpecifies whether the document includes a preview, and, if so, whether the preview shows only the first page or all the
PrintPageOrientationDetermines whether the page is printed in portrait or landscape orientation.
PrintPropsContains elements that control how the drawing page is formatted (appears) on the printer page.
PrintSaveOptionsAllows to specify additional options when printing diagram.
PropContains elements for defining custom properties and elements for associating data with a shape.
PropCollectionProp collection.
ProtectionLocking helps prevent inadvertent changes to the shape but does not prevent Microsoft Visio from resetting values in oth
RadioButtonActiveXControlRepresents a RadioButton ActiveX control.
RelCubBezToContains x- and y-coordinates for a RelCubBezTo’s points.
RelCubBezToCollectionRelCubBezTo collection.
RelEllipticalArcToContains elements that specify information about an elliptical arc.Coordinates are specified as relative coordinates.
RelEllipticalArcToCollectionRelEllipticalArcTo collection.
RelLineToContains x- and y-coordinates of the ending vertex of a straight line segment. These coordinates are contained in the X
RelLineToCollectionRelLineTo collection.
RelMoveToContains the x- and y-coordinates of the first vertex of a shape, or contains the x- and y-coordinates of the first vert
RelMoveToCollectionRelMoveTo collection.
RelQuadBezToContains x- and y-coordinates for a RelQuadBezTo’s points.
RelQuadBezToCollectionRelQuadBezTo collection.
RelationShapeContains elements that define a shape and relationflag.
RelationShapeCollectionRelationShape collection.
RenderingSaveOptionsThis is an abstract base class for classes that allow the user to specify additional options when saving a diagram into
ResizeModeSpecifies the current resize behavior setting for the shape when contained in a group.
ReviewerContains elements that contain identifying information about a document reviewer.
ReviewerCollectionReviewer collection.
RotationTypeSpecifies the type of shadow for a shape.
RouteStyleSpecifies the routing style and direction for all dynamic connectors on the drawing page that don’t have a local routing
RowIndicates a row in the data recordset.
RowCollectionRow collection.
RuleRepresents a single validation rule in a diagram validation rule set.
RuleCollectionRule collection.
RuleInfoSpecifies information about the validation rule that the parent validation issue pertains to.
RuleSetRepresents one set of diagram validation rules.
RuleSetCollectionRuleSet collection.
RuleValueRule value.
RulerDensitySpecifies the horizontal subdivisions on the ruler for the page.
RulerGridContains elements that specify the settings of the page’s rulers and grid.
SVGSaveOptionsAllows to specify additional options when rendering diagram pages to SVG.
SaveOptionsThis is an abstract base class for classes that allow the user to specify additional options when saving a diagram into
ScratchContains a work area for entering and testing formulas that are referred to by other elements. This element is typically
ScratchCollectionScratch collection.
ScrollBarActiveXControlRepresents the ScrollBar control.
SelectModeSpecifies how the user selects a group shape and its members.
ShapeContains elements that define a shape in a Master, Page, or group shape element.
ShapeCollectionCollection of Shapes.
ShapeFixedCodeSpecifies placement behavior for a placeable shape.
ShapePlaceFlipSpecifies how a placeable shape flips and/or rotates on the page when a user selects Lay Out Shapes (Shapes menu).
ShapePlaceStyleDetermines the placement style for children.
ShapePlowCodeSpecifies whether a placeable shape moves away when you drag another placeable shape near the shape on the drawing page.
ShapeRouteStyleSpecifies the routing style and direction for a connector on the drawing page.
ShapeShdwShowSpecifies the type of shadow for a shape.
ShapeShdwTypeSpecifies the type of shadow for a shape.
ShdwTypeIndicates the default shadow type for a page.
SmartTagDefContains elements that contain information for each smart tag defined for a shape or page.
SmartTagDefCollectionSmartTagDef collection.
SolutionXMLContains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document
SolutionXMLCollectionSolutionXML collection.
SpinButtonActiveXControlRepresents the SpinButton control.
SplineKnotContains x- and y-coordinates for a spline’s control point and a spline’s knot, represented by the X, Y, and A elements,
SplineKnotCollectionSplineKnot collection.
SplineStartContains x- and y-coordinates for a spline’s second control point, its second knot, its first knot, the last knot, and t
SplineStartCollectionSplineStart collection.
Str2ValueString value.
StrValueString value
StyleSpecifies the character formatting applied to a range of text in the shape’s text block.
StylePropContains elements that control style behavior, such as whether a style includes text, line, and fill attributes.
StyleSheetRepresents a style defined in a document.
StyleSheetCollectionCollection of StyleSheets.
TabContains a collection of Tab elements.
TabCollectionContains a collection of Tab elements
TabsCollectionContains a collection of TabCollection elements
TextContains the text of a shape.
TextBlockContains elements that specify the alignment, margins, and default tab stop positions of text in a shape’s text block.
TextBoxActiveXControlRepresents a text box ActiveX control.
TextCollectionContains the text of a shape. Each item is text with character, paragraph and tabs properties.
TextDirectionSpecifies the direction of the characters in a text block.
TextXFormContains elements that specify positioning information about a shape’s text block.
ThreeDFormatRepresents a shape’s three-dimensional formatting.
TimeLineHelperTimeLineHelper to set property of timeline shape.
ToggleButtonActiveXControlRepresents a ToggleButton ActiveX control.
TpSpecifies the beginning of a tabs properties run. The run is defined to the end of the text or until the next
TxtText of the shape
TxtSaveOptionsRepresents the save options for csv/other text format.
TypeConnectionSpecifies various types, based on the element in which it is contained.
TypeFieldType specifies a data type for the text field value.
TypePropType specifies a data type for the custom property value.
UIVisibilitySpecifies the tab alignment.
UnitFormulaErrSpecifies attributes of an element.
UnitFormulaErrVSpecified attributes of an element.
UnknownControlUnknow control.
UserContains a work area for entering formulas in user-specific elements that are referred to by other elements and add-on t
UserCollectionUser collection.
ValidationStores information about diagram validation for the document.
ValidationPropertiesEncapsulates properties related to validation for the document.
ValueValue.
VbaModuleRepresents module that is contained in VBA project.
VbaModuleCollectionRepresents the list of VbaModule
VbaProjectRepresents the VBA project.
VbaProjectReferenceRepresents the refernece of VBA project.
VbaProjectReferenceCollectionRepresents all references of VBA project.
VerticalAlignSpecifies the vertical alignment of text within the text block.
WalkPreferenceSpecifies whether an endpoint of a 1-D shape moves to a horizontal or vertical connection point on the shape it is glued
WarningInfoWarning info
WindowRepresents an open window in a Microsoft Visio instance. This element contains information necessary to exactly re-creat
WindowCollectionWindow collection.
XAMLSaveOptionsAllows to specify additional options when rendering diagram pages to XAML.
XFormContains elements that control line attributes for a shape, such as pattern, weight, and color. These elements determine
XForm1DContains x- and y-coordinates of the begin point and end point of a 1-D shape. This element appears for 1-D shapes only.
XJustifyThe x-offset of the smart tag button relative to the point defined by the X and Y elements.
XPSSaveOptionsAllows to specify additional options when rendering diagram pages to XPS.
YJustifySpecifies the y-offset of the smart tag button relative to the point defined by the X and Y elements.