New Members and Constants (Visio)

Articolo
09/15/2015

New Members

The following properties, methods, and events have been added to existing objects in Microsoft Visio 2010.

Application

Properties	Description
DeferRelationshipRecalc	Determines whether Microsoft Visio defers recalculating shape sizes and relationships when a member of the relationship pair is moved or resized. Read/write.
CurrentEdition	Returns an enumerated value that represents the edition of the current instance of Microsoft Visio. Read-only.
InstanceHandle64	Gets the instance handle of the Application object for a 64-bit version of Microsoft Visio. Read-only.

Methods	Description
SetPreviewEnabled	Turns preview on or off for a gallery in the Microsoft Visio user interface.
UnregisterRibbonX	Unregisters a previouly registered IRibbonExtensiblity interface that a Microsoft Visio add-in implements.
RegisterRibbonX	Registers the IRibbonExtensibility interface that is implemented by the specified add-on to populate the custom user interface (UI).
GetCustomStencilFile	Returns the path to the specified custom stencil used to populate certain galleries in the Microsoft Visio user interface.
GetBuiltInStencilFile	Returns the file path to the specified built-in, hidden stencil used to populate certain galleries in the Microsoft Visio user interface.
GetPreviewEnabled	Returns a value that indicates whether preview is enabled for the specified gallery in the Microsoft Visio user interface.

Events	Description
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from the application.
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.
CalloutRelationshipAdded	Occurs when a new callout relationship is added to the application.
RuleSetValidated	Occurs when a rule set is validated.
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.

ApplicationSettings

Properties	Description
RasterExportFlip	Determines the flip that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a BMP, GIF, JPG, PNG, or TIFF file. Read/write.
RasterExportOperation	Determines the export operation that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a JPG file. Read/write.
EnableFormulaAutoComplete	Indicates whether ShapeSheet formula AutoComplete is enabled. Read/write.
RasterExportBackgroundColor	Determines the background color that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a BMP, GIF, JPG, PNG, or TIFF file. Read/write.
RasterExportDataFormat	Determines whether the exported raster image is interlaced or non-interlaced when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a GIF or PNG file. Read/write.
TransitionsEnabled	Determines whether Microsoft Visio uses an animated transition to show certain shape movements, such as re-layout of shapes. Read/write.
DeleteConnectorsEnabled	Determines whether connectors are deleted when a shape to which they are connected is deleted. Read/write.
RasterExportDataCompression	Determines the data compression algorithm that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a GIF or PNG file. Read/write.
RasterExportColorFormat	Determines the color format that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a BMP, GIF, PNG, or TIFF file. Read/write.
RasterExportColorReduction	Determines the color reduction that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a BMP, GIF, PNG, or TIFF file. Read/write.
RecentTemplatesListSize	Determines the number of entries in the Recent Templates list in the Microsoft Visio user interface. Read/write.
RasterExportUseTransparencyColor	Determines whether Microsoft Visio applies, to the exported image, the transparency color that is specified in the RasterExportTransparencyColor property when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a GIF or PNG file. Read/write.
RasterExportTransparencyColor	Determines the transparency color that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a GIF or PNG file. Read/write.
RasterExportRotation	Determines the rotation that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a BMP, GIF, JPG, PNG, or TIFF file. Read/write.
RasterExportQuality	Determines the export quality that is applied to the exported image when you call the Export method of the Master, Page, Selection, or Shape object to export the specified object to a JPG file. Read/write.
ApplyBackgroundToDocument	Determines whether the selected background or border is applied to all pages in the document (True) or only to the current page (False). Read/write.

Methods	Description
GetRasterExportResolution	Returns the raster export resolution settings.
SetRasterExportResolution	Specifies the raster export resolution settings.
GetRasterExportSize	Gets the raster export size.
SetRasterExportSize	Sets the raster export size.

Document

Properties	Description
CustomUI	Gets or sets the Ribbon XML string that is passed to the document to customize the Microsoft Office Fluent user interface. Read/write.
DiagramServicesEnabled	Determines which, if any, diagram services are enabled for the document. Read/write.
UserCustomUI	Gets or sets the Ribbon XML string that is passed to the document to customize the Quick Access toolbar or the Ribbon. Read/write.
Validation	Returns the Validation object that is associated with the document. Read-only.
ServerPublishOptions	Returns a ServerPublishOptions object that you can use to specify the settings to apply when you save a document as a Web drawing (as a .vdw file), then publish and use it on a Microsoft SharePoint site in conjunction with Visio Services. Read-only.

Events	Description
RuleSetValidated	Occurs when a rule set is validated.

Documents

Events	Description
CalloutRelationshipAdded	Occurs when a new callout relationship is added to a document.
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from a document.
RuleSetValidated	Occurs when a rule set is validated.
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.

InvisibleApp

Properties	Description
DeferRelationshipRecalc	Determines whether Microsoft Visio defers recalculating shape sizes and relationships when a member of a relationship pair is moved or resized. Read/write.
InstanceHandle64	Gets the instance handle of the InvisibleApp object for a 64-bit version of Microsoft Visio. Read-only.
CurrentEdition	Returns an enumerated value that represents the edition of the current instance of Microsoft Visio. Read-only.

Methods	Description
SetPreviewEnabled	Turns preview on or off for a gallery in the Microsoft Visio user interface.
GetPreviewEnabled	Returns a value that indicates whether preview is enabled for the specified gallery in the Microsoft Visio user interface.
RegisterRibbonX	Registers the IRibbonExtensibility interface that is implemented by the specified add-on to populate the custom user interface (UI).
GetBuiltInStencilFile	Returns the file path to the specified built-in, hidden stencil used to populate certain galleries in the Microsoft Visio user interface.
UnregisterRibbonX	Unregisters a previouly registered IRibbonExtensiblity interface that a Microsoft Visio add-in implements.
GetCustomStencilFile	Returns the path to the specified custom stencil used to populate certain galleries in the Microsoft Visio user interface.

Events	Description
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.
RuleSetValidated	Occurs when a rule set is validated.
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from the application.
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.
CalloutRelationshipAdded	Occurs when a new callout relationship is added to the application.

Master

Methods	Description
PasteToLocation	Pastes a shape to the specified location.

Page

Properties	Description
LayoutRoutePassive	Determines whether to enable advanced connector routing logic on the page. Read/write.
AutoSize	Determines whether Microsoft Visio automatically resizes the drawing page by adding printer-paper-sized sheets, as necessary, to fit the drawing's contents. Read/write.

Methods	Description
LayoutChangeDirection	Revises the layout of a set of connected shapes on the page, by rotating or flipping a connected diagram without rotating or flipping the individual shapes.
GetContainers	Returns an array of shape identifiers (IDs) of the container shapes on the page.
DropLegend	Inserts a data graphics legend on a Microsoft Visio drawing page. Returns the list shape instance specified in the OuterList parameter.
DropIntoList	Drops the specified object into the specified list at the specified position. Returns the newly dropped shape.
SplitConnector	Splits the specified connector with the specified shape. Returns the new duplicated connector.
DropCallout	Creates a new callout Shape object on the page near the specified target shape, and associates the callout with the target shape. Returns the callout shape.
LayoutIncremental	Makes small adjustments to the position of shapes on the drawing page to better align the shapes or to space them evenly from other shapes.
DropContainer	Creates a new container Shape object on the page, places the container around the specified target shapes, and adds the target shapes to the container. Returns the container shape.
AutoConnectMany	Automatically draws multiple connections in the specified directions between the specified shapes. Returns the number of shapes connected.
AvoidPageBreaks	Makes small adjustments to shapes to move them off page breaks.
PasteToLocation	Pastes the shape to the specified location on the page.
GetCallouts	Returns the list of identifiers of the callout shapes on the page.
AutoSizeDrawing	Automatically resizes the drawing page by adding as many printer-paper-sized tiles as necessary to fit all shapes in the drawing onto the page.
DropConnected	Creates a new Shape object on the page, places the new shape relative to the specified existing target shape, and adds a connector from the existing shape to the new shape. Returns the newly created shape.

Events	Description
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from the page.
CalloutRelationshipAdded	Occurs when a new callout relationship is added to the page.

Pages

Events	Description
CalloutRelationshipAdded	Occurs when a new callout relationship is added to a page.
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from a page.
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.

Selection

Properties	Description
SelectionForDragCopy	Returns the Selection object that represents the collection of shapes that will participate in drag or copy operations, based on the current selection. Read-only.

Methods	Description
GetContainers	Returns an array of shape identifiers (IDs) of the container shapes in the selection.
MemberOfContainersIntersection	Returns an array of identifiers of the shapes that belong to the normal or list containers that contain all the shapes in the selection.
AddToContainers	Adds the selection of shapes to all underlying containers that allow it as a member.
MoveToSubprocess	Moves the selection to the specified page, and drops a replacement shape on the source page and links it to the target page. Returns the selection of moved shapes on the target page.
MemberOfContainersUnion	Returns an array of identifiers of the shapes that belong to the normal or list containers that contain at least one of the shapes in the selection.
AvoidPageBreaks	Makes small adjustments to selected shapes to move them off page breaks.
LayoutIncremental	Makes small adjustments to the position of shapes in the selection to better align the shapes or to space them evenly from other shapes.
RemoveFromContainers	Removes the selection of shapes from all lists and containers of which the selection is a member.
LayoutChangeDirection	Revises the layout of a selection of connected shapes by rotating or flipping a connected diagram without rotating or flipping the individual shapes.
Resize	Resizes the selection by moving shape handles as specified.
DeleteEx	Deletes additional shapes associated with the selection, such as connectors and unselected container members, when the selection is deleted.
GetCallouts	Returns the list of identifiers of the callout shapes in the selection.
SetContainerFormat	Changes the formatting of one aspect of all the containers in the selection, and returns an array of identifiers of shapes that belong to the containers and whose formatting was changed.

Shape

Properties	Description
MemberOfContainers	Returns an array of Long values that represent the identifiers of the container shapes that include the shape as a member. Read-only.
CalloutsAssociated	Returns an array of Long values that represent the collection of identifiers for all of the callout shapes that are associated with the target shape by a callout relationship. Read-only.
ContainerProperties	Returns the ContainerProperties object associated with the shape. Read-only.
CalloutTarget	Gets or sets the target shape that is associated with the callout shape by a callout relationship. Read/write.
IsCallout	Indicates whether the shape is a callout shape. Read-only.

Methods	Description
MoveToSubprocess	Moves the shape to the specified page and drops a replacement shape on the source page, then links it to the target page. Returns the selection of moved shapes on the target page.
GluedShapes	Returns an array that contains the identifiers of the shapes that are glued to a shape.
ConnectedShapes	Returns an array that contains the identifiers (IDs) of the shapes that are connected to the shape.
HasCategory	Returns True if the specified category is in the shape categories list.
Resize	Resizes the shape by moving shape handles as specified.
RemoveFromContainers	Removes the shape from all lists and containers of which it is a member.
Disconnect	Unglues the specified connector end points and offsets them the specified amount from the shapes to which they were joined.
DeleteEx	Deletes the additional shapes that are associated with the shape, such as connectors and unselected container members, when the shape is deleted.
AddToContainers	Adds the shape to all underlying containers that allow it as a member.
CreateSubProcess	Creates and returns a new sub-process page that is linked to the shape.

Shapes

Properties	Description
ItemFromUniqueID	Returns the Shape object that matches the specified UniqueID property value. Read-only.

Window

Properties	Description
SelectedValidationIssue	Gets or sets the validation issue that is selected in the Issues window. Read/write.
SelectionForDragCopy	Returns the Selection object that represents the collection of shapes that will participate in drag or copy operations, based on the current selection. Read-only.

Methods	Description
CenterViewOnShape	Pans the Microsoft Visio drawing window to place the specified shape in the center of the view.

New Constants

The following constants have been added to existing enumerations in Microsoft Visio 2010.

Enumeration	New Constants
VisCellIndices	visActionFlyoutChild visCompNoQuickDrag visPageDrawResizeType visPageZOrderChanged visPLOAvoidPageBreaks visSLOCategoryChanged visSLODisplayLevel visSLORelationships visSLORelChanged
VisCutCopyPasteCodes	visCopyPasteNormal visCopyPasteNoTranslate visCopyPasteCenter visCopyPasteDontAddToContainers visCopyPasteNoAssociatedCallouts visCopyPasteNoContainerMembers visCopyPasteNoHealConnectors visCopyPasteNoCascade
VisDocVersions	visVersion140
VisEventCodes	visEvtCodeCalloutRelationshipAdded visEvtCodeCalloutRelationshipDeleted visEvtCodeContainerRelationshipAdded visEvtCodeContainerRelationshipDeleted visEvtCodeRuleSetValidated visEvtCodeSelectionMovedToSubprocess
VisObjectTypes	visObjTypeContainerProperties visObjTypeMovedSelectionEvent visObjTypeRelatedShapePairEvent visObjTypeServerPublishOptions visObjTypeValidation visObjTypeValidationIssue visObjTypeValidationIssues visObjTypeValidationRule visObjTypeValidationRules visObjTypeValidationRuleSet visObjTypeValidationRuleSets
VisRemoveHiddenInfoItems	visRHIValidationRules
VisSelectionTypes	visSelTypeByRole
VisSpatialRelationFlags	visSpatialIncludeContainerShapes
VisThemeColors	visThemeColorsAdjacency visThemeColorsAngles visThemeColorsApothecary visThemeColorsAustin visThemeColorsBasic visThemeColorsBlackTie visThemeColorsClarity visThemeColorsComposite visThemeColorsCouture visThemeColorsElemental visThemeColorsEssential visThemeColorsExecutive visThemeColorsGrid visThemeColorsHardcover visThemeColorsHorizon visThemeColorsNewsprint visThemeColorsPerspective visThemeColorsPushpin visThemeColorsSlipstream visThemeColorsThatch visThemeColorsWaveform
VisThemeEffects	visThemeEffectsBasicShadow
VisUICmds	visCmdActivateQuickShapesWnd visCmdAddMemberToContainer visCmdAddToAllContainers visCmdAddToNewContainer visCmdApplyMainTheme visCmdApplyMainThemeToDocument visCmdApplyMainThemeToPage visCmdApplyThemeColors visCmdApplyThemeEffects visCmdApplyThemeToNewShapesToggle visCmdAssociateCallout visCmdAutoAlign visCmdAutoAlignAndSpace visCmdAutoSizeDrawing visCmdAutoSpace visCmdCloseInkToolsRibbonTab visCmdCollapseShapesWindow visCmdCOMAddinsDlg visCmdContainerAutoResizeExpandContract visCmdContainerAutoResizeExpandOnly visCmdContainerAutoResizeOff visCmdCreateSubProcessFromSel visCmdDeleteConnectors visCmdDiagramFlipHorizontal visCmdDiagramFlipVertical visCmdDiagramRotateLeft visCmdDiagramRotateRight visCmdDisbandContainer visCmdDropAndContain visCmdDropAndInsertIntoList visCmdDropCallout visCmdEditRedoOrRepeat visCmdEditThemeColors visCmdEditThemeEffects visCmdFileLastFile10 visCmdFileLastFile11 visCmdFileLastFile12 visCmdFileLastFile13 visCmdFileLastFile14 visCmdFileLastFile15 visCmdFileLastFile16 visCmdFileLastFile17 visCmdFileLastFile18 visCmdFileLastFile19 visCmdFileLastFile20 visCmdFileSaveAsDrawing visCmdFileSaveAsDrawingPreviousFileFormat visCmdFileSaveAsDWG visCmdFileSaveAsEMF visCmdFileSaveAsJPG visCmdFileSaveAsPNG visCmdFileSaveAsSVG visCmdFileSaveAsTemplate visCmdFileSaveAsVDX visCmdFitContainerToContents visCmdFormatPictureAutobalance visCmdFormatPictureCompressionDlg visCmdIgnoreValidationIssue visCmdIgnoreValidationRule visCmdInsertCheckBoxControl visCmdInsertClipArtDlg visCmdInsertComboBoxControl visCmdInserTextBoxControl visCmdInsertImageControl visCmdInsertLabelControl visCmdInsertLegendHorizontal visCmdInsertLegendVertical1 visCmdInsertListBoxControl visCmdInsertMemberIntoList visCmdInsertNewBackgroundPage visCmdInsertPageTab visCmdInsertPushButtonControl visCmdInsertRadioButtonControl visCmdInsertScrollBarControl visCmdInsertSpinControl visCmdInsertToggleButtonControl visCmdLanguagePreferencesDlg visCmdLayoutSpacingDlg visCmdListInsertAfter visCmdListInsertBefore visCmdLockContainer visCmdMinimizeRibbonToggle visCmdMoveOffPageBreaks visCmdMultipleFileImport visCmdNewForegroundPage visCmdNewSubProcess visCmdNextCommentMarkup visCmdOfficeCenterOptions visCmdPageAutoSizeToggle visCmdPageSizeDlg visCmdPageSizeToFitDrawing visCmdPasteToLocation visCmdPostDrag visCmdPreviousCommentMarkup visCmdPublishToProcessRepository visCmdPublishToVisioServices visCmdReinstateValidationIssue visCmdRemoveFromAllContainers visCmdRemoveMemberFromContainer visCmdRemoveMemberFromList visCmdReorderList visCmdResearchThesaurus visCmdSelectContainerMembers visCmdSetAutoSize visCmdSetContainerProperties visCmdSetDiagramServices visCmdSetPageOrientation visCmdSetPageSize visCmdShapeSearchWindowToggle visCmdShowIgnoredIssuesToggle visCmdShowLineJumpsToggle visCmdShowShapeSheetDocument visCmdShowShapeSheetPage visCmdShowShapeSheetShape visCmdSpaceShapesAvoidPageBreaksToggle visCmdStopIgnoringValidationRule visCmdTranslateOptions visCmdValidateDiagram visCmdValidationIssueNavigateToShape visCmdValidationIssuesArrangeByCategory visCmdValidationIssuesArrangeByIgnored visCmdValidationIssuesArrangeByPage visCmdValidationIssuesArrangeByRule visCmdValidationIssuesArrangeOriginalOrder visCmdValidationIssuesWindowToggle
VisUIObjSets	visUIObjSetCntx_Issues visUIObjSetCntx_Page visUIObjSetCntx_PageTabNavigation
VisWinTypes	visWinIDValidationIssues