API Reference
VisioPage
Represents a single page within a Visio document.
Inheritance
- Object
- VisioPage
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method VisioConnectorRoutingExtensions.RouteConnectorsOrthogonalAroundShapes
- Method VisioConnectorRoutingExtensions.RouteConnectorsOrthogonalAroundShapes
- Method VisioDiagramPolishExtensions.PolishDiagram
- Method VisioDiagramQualityAnalyzer.EnsureVisualQuality
- Extension method VisioDocument.DuplicatePage
- Extension method VisioDocument.DuplicatePage
- Method VisioDocument.AddBackgroundPage
- Method VisioDocument.AddPage
- Property VisioDocument.Pages
- Method VisioDuplicationExtensions.DuplicatePage
- Method VisioLayoutExtensions.CenterContent
- Method VisioLayoutExtensions.FitToContent
- Method VisioLayoutExtensions.FitToContent
- Method VisioLayoutExtensions.ResolveConnectorLabelOverlaps
- Method VisioLayoutExtensions.ResolveShapeOverlaps
- Extension method VisioPage.CenterContent
- Extension method VisioPage.Duplicate
- Extension method VisioPage.Duplicate
- Extension method VisioPage.EnsureVisualQuality
- Extension method VisioPage.FitToContent
- Extension method VisioPage.FitToContent
- Extension method VisioPage.MoveSwimlaneActivity
- Extension method VisioPage.PolishDiagram
- Extension method VisioPage.RelayoutSwimlaneActivities
- Extension method VisioPage.ResolveConnectorLabelOverlaps
- Extension method VisioPage.ResolveShapeOverlaps
- Extension method VisioPage.RouteConnectorsOrthogonalAroundShapes
- Extension method VisioPage.RouteConnectorsOrthogonalAroundShapes
- Method VisioPage.AddToLayer
- Method VisioPage.ClearBackgroundPage
- Method VisioPage.ClearConnectorRoutingPolicy
- Method VisioPage.ClearConnectorSpacing
- Method VisioPage.ClearLayoutGridPolicy
- Method VisioPage.ClearLayoutGridSizing
- Method VisioPage.ClearPlacementPolicy
- Method VisioPage.Grid
- Method VisioPage.SetBackgroundPage
- Method VisioPage.SetConnectorSpacing
- Method VisioPage.SetConnectorSpacing
- Method VisioPage.SetLayoutGridSizing
- Method VisioPage.SetLayoutGridSizing
- Method VisioPage.SetMargins
- Method VisioPage.SetMargins
- Method VisioPage.SetMargins
- Method VisioPage.Size
- Property VisioPage.BackgroundPage
- Property VisioShapeSelection.OwnerPage
- Method VisioSwimlaneMaintenanceExtensions.MoveSwimlaneActivity
- Method VisioSwimlaneMaintenanceExtensions.RelayoutSwimlaneActivities
Accepted by parameters
- Method VisioFluentDocument.Page
- Constructor VisioFluentPage.VisioFluentPage
- Method VisioStencilGalleryExtensions.AddStencilGallery
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioStencilPageExtensions.AddStencilShape
- Method VisioCalloutExtensions.AddCallout
- Method VisioCalloutExtensions.AddCallout
- Method VisioCalloutExtensions.AddCallout
- Method VisioCalloutExtensions.AddCallout
- Method VisioCommentExtensions.AddComment
- Method VisioCommentExtensions.AddComment
- Method VisioCommentExtensions.AddCommentToShape
- Method VisioCommentExtensions.CommentsForShape
- Method VisioCommentExtensions.CommentsForShape
- Method VisioCommentExtensions.FindComment
- Method VisioCommentExtensions.RemoveComment
- Method VisioCommentExtensions.RemoveComment
- Method VisioCommentExtensions.RemoveCommentsForShape
- Method VisioCommentExtensions.ReopenComment
- Method VisioCommentExtensions.ResolveComment
- Method VisioCommentExtensions.ResolvedComments
- Method VisioCommentExtensions.UnresolvedComments
- Method VisioCommentExtensions.UpdateCommentText
- Method VisioConnectorRoutingExtensions.RouteConnectorsOrthogonalAroundShapes
- Method VisioConnectorRoutingExtensions.RouteConnectorsOrthogonalAroundShapes
- Method VisioContainerEditingExtensions.AddToContainer
- Method VisioContainerEditingExtensions.AddToContainer
- Method VisioContainerEditingExtensions.ApplyContainerOptions
- Method VisioContainerEditingExtensions.ConfigureContainer
- Method VisioContainerEditingExtensions.GetContainerInfo
- Method VisioContainerEditingExtensions.GetContainerMembers
- Method VisioContainerEditingExtensions.GetContainerOptions
- Method VisioContainerEditingExtensions.RefitContainer
- Method VisioContainerEditingExtensions.RemoveFromContainer
- Method VisioContainerEditingExtensions.RemoveFromContainer
- Method VisioDataGraphicExtensions.AddDataGraphics
- Method VisioDiagramPolishExtensions.PolishDiagram
- Method VisioDiagramQualityAnalyzer.AnalyzeVisualQuality
- Method VisioDiagramQualityAnalyzer.EnsureVisualQuality
- Method VisioDiagramQualityAnalyzer.GetVisualQualityReport
- Extension method VisioDocument.DuplicatePage
- Extension method VisioDocument.DuplicatePage
- Method VisioDuplicationExtensions.Duplicate
- Method VisioDuplicationExtensions.Duplicate
- Method VisioDuplicationExtensions.DuplicatePage
- Method VisioDuplicationExtensions.DuplicatePage
- Method VisioDuplicationExtensions.DuplicateShapes
- Method VisioDuplicationExtensions.DuplicateShapes
- Method VisioLayoutExtensions.CenterContent
- Method VisioLayoutExtensions.FitToContent
- Method VisioLayoutExtensions.FitToContent
- Method VisioLayoutExtensions.GetContentBounds
- Method VisioLayoutExtensions.ResolveConnectorLabelOverlaps
- Method VisioLayoutExtensions.ResolveShapeOverlaps
- Method VisioMasterEditingExtensions.ReplaceMaster
- Method VisioMasterEditingExtensions.ReplaceMaster
- Method VisioMasterEditingExtensions.ReplaceMaster
- Extension method VisioPage.AddCallout
- Extension method VisioPage.AddCallout
- Extension method VisioPage.AddCallout
- Extension method VisioPage.AddCallout
- Extension method VisioPage.AddComment
- Extension method VisioPage.AddComment
- Extension method VisioPage.AddCommentToShape
- Extension method VisioPage.AddDataGraphics
- Extension method VisioPage.AddStencilGallery
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddStencilShape
- Extension method VisioPage.AddToContainer
- Extension method VisioPage.AddToContainer
- Extension method VisioPage.AllShapes
- Extension method VisioPage.ApplyContainerOptions
- Extension method VisioPage.Callouts
- Extension method VisioPage.CenterContent
- Extension method VisioPage.CommentsForShape
- Extension method VisioPage.CommentsForShape
- Extension method VisioPage.ConfigureContainer
- Extension method VisioPage.ConnectedComponent
- Extension method VisioPage.ConnectedConnectors
- Extension method VisioPage.ConnectedShapes
- Extension method VisioPage.ConnectorsInLayer
- Extension method VisioPage.ConnectorsWithHyperlink
- Extension method VisioPage.ConnectorsWithHyperlinks
- Extension method VisioPage.ConnectorsWithProtection
- Extension method VisioPage.ConnectorsWithProtection
- Extension method VisioPage.Containers
- Extension method VisioPage.Duplicate
- Extension method VisioPage.Duplicate
- Extension method VisioPage.DuplicateShapes
- Extension method VisioPage.DuplicateShapes
- Extension method VisioPage.FindComment
- Extension method VisioPage.FindShapeById
- Extension method VisioPage.FindSwimlaneLane
- Extension method VisioPage.FindSwimlanePhase
- Extension method VisioPage.FitToContent
- Extension method VisioPage.FitToContent
- Extension method VisioPage.GetContainerInfo
- Extension method VisioPage.GetContainerMembers
- Extension method VisioPage.GetContainerOptions
- Extension method VisioPage.GetContentBounds
- Extension method VisioPage.GetSwimlaneActivities
- Extension method VisioPage.GetSwimlaneLanes
- Extension method VisioPage.GetSwimlanePhases
- Extension method VisioPage.IncomingConnectors
- Extension method VisioPage.MoveSwimlaneActivity
- Extension method VisioPage.OutgoingConnectors
- Extension method VisioPage.PathBetween
- Extension method VisioPage.PolishDiagram
- Extension method VisioPage.RefitContainer
- Extension method VisioPage.RelayoutSwimlaneActivities
- Extension method VisioPage.RemoveComment
- Extension method VisioPage.RemoveComment
- Extension method VisioPage.RemoveCommentsForShape
- Extension method VisioPage.RemoveFromContainer
- Extension method VisioPage.RemoveFromContainer
- Extension method VisioPage.ReopenComment
- Extension method VisioPage.ReplaceMaster
- Extension method VisioPage.ReplaceMaster
- Extension method VisioPage.ReplaceMaster
- Extension method VisioPage.ResolveComment
- Extension method VisioPage.ResolveConnectorLabelOverlaps
- Extension method VisioPage.ResolvedComments
- Extension method VisioPage.ResolveShapeOverlaps
- Extension method VisioPage.RouteConnectorsOrthogonalAroundShapes
- Extension method VisioPage.RouteConnectorsOrthogonalAroundShapes
- Extension method VisioPage.SelectByMaster
- Extension method VisioPage.SelectByName
- Extension method VisioPage.SelectByNameU
- Extension method VisioPage.SelectCallouts
- Extension method VisioPage.SelectConnectedComponent
- Extension method VisioPage.SelectConnectedConnectors
- Extension method VisioPage.SelectConnectors
- Extension method VisioPage.SelectConnectorsInLayer
- Extension method VisioPage.SelectConnectorsWithHyperlink
- Extension method VisioPage.SelectConnectorsWithHyperlinks
- Extension method VisioPage.SelectConnectorsWithProtection
- Extension method VisioPage.SelectConnectorsWithProtection
- Extension method VisioPage.SelectContainedIn
- Extension method VisioPage.SelectContainedIn
- Extension method VisioPage.SelectContainers
- Extension method VisioPage.SelectContainingText
- Extension method VisioPage.SelectIncomingConnectors
- Extension method VisioPage.SelectIntersecting
- Extension method VisioPage.SelectIntersecting
- Extension method VisioPage.SelectLayer
- Extension method VisioPage.SelectOutgoingConnectors
- Extension method VisioPage.SelectPathBetween
- Extension method VisioPage.SelectShapes
- Extension method VisioPage.SelectWithData
- Extension method VisioPage.SelectWithData
- Extension method VisioPage.SelectWithData
- Extension method VisioPage.SelectWithHyperlink
- Extension method VisioPage.SelectWithHyperlinks
- Extension method VisioPage.SelectWithProtection
- Extension method VisioPage.SelectWithProtection
- Extension method VisioPage.SelectWithShapeData
- Extension method VisioPage.SelectWithShapeData
- Extension method VisioPage.SelectWithShapeData
- Extension method VisioPage.SelectWithUserCell
- Extension method VisioPage.SelectWithUserCell
- Extension method VisioPage.ShapesByMaster
- Extension method VisioPage.ShapesByName
- Extension method VisioPage.ShapesByNameU
- Extension method VisioPage.ShapesContainedIn
- Extension method VisioPage.ShapesContainedIn
- Extension method VisioPage.ShapesContainingText
- Extension method VisioPage.ShapesInLayer
- Extension method VisioPage.ShapesIntersecting
- Extension method VisioPage.ShapesIntersecting
- Extension method VisioPage.ShapesWithData
- Extension method VisioPage.ShapesWithData
- Extension method VisioPage.ShapesWithData
- Extension method VisioPage.ShapesWithHyperlink
- Extension method VisioPage.ShapesWithHyperlinks
- Extension method VisioPage.ShapesWithProtection
- Extension method VisioPage.ShapesWithProtection
- Extension method VisioPage.ShapesWithShapeData
- Extension method VisioPage.ShapesWithShapeData
- Extension method VisioPage.ShapesWithShapeData
- Extension method VisioPage.ShapesWithUserCell
- Extension method VisioPage.ShapesWithUserCell
- Extension method VisioPage.UnresolvedComments
- Extension method VisioPage.UpdateCommentText
- Method VisioPage.SetBackgroundPage
- Method VisioPageQueryExtensions.AllShapes
- Method VisioPageQueryExtensions.Callouts
- Method VisioPageQueryExtensions.ConnectedComponent
- Method VisioPageQueryExtensions.ConnectedConnectors
- Method VisioPageQueryExtensions.ConnectedShapes
- Method VisioPageQueryExtensions.ConnectorsInLayer
- Method VisioPageQueryExtensions.ConnectorsWithHyperlink
- Method VisioPageQueryExtensions.ConnectorsWithHyperlinks
- Method VisioPageQueryExtensions.ConnectorsWithProtection
- Method VisioPageQueryExtensions.ConnectorsWithProtection
- Method VisioPageQueryExtensions.Containers
- Method VisioPageQueryExtensions.FindShapeById
- Method VisioPageQueryExtensions.IncomingConnectors
- Method VisioPageQueryExtensions.OutgoingConnectors
- Method VisioPageQueryExtensions.PathBetween
- Method VisioPageQueryExtensions.SelectByMaster
- Method VisioPageQueryExtensions.SelectByName
- Method VisioPageQueryExtensions.SelectByNameU
- Method VisioPageQueryExtensions.SelectCallouts
- Method VisioPageQueryExtensions.SelectConnectedComponent
- Method VisioPageQueryExtensions.SelectConnectedConnectors
- Method VisioPageQueryExtensions.SelectConnectors
- Method VisioPageQueryExtensions.SelectConnectorsInLayer
- Method VisioPageQueryExtensions.SelectConnectorsWithHyperlink
- Method VisioPageQueryExtensions.SelectConnectorsWithHyperlinks
- Method VisioPageQueryExtensions.SelectConnectorsWithProtection
- Method VisioPageQueryExtensions.SelectConnectorsWithProtection
- Method VisioPageQueryExtensions.SelectContainedIn
- Method VisioPageQueryExtensions.SelectContainedIn
- Method VisioPageQueryExtensions.SelectContainers
- Method VisioPageQueryExtensions.SelectContainingText
- Method VisioPageQueryExtensions.SelectIncomingConnectors
- Method VisioPageQueryExtensions.SelectIntersecting
- Method VisioPageQueryExtensions.SelectIntersecting
- Method VisioPageQueryExtensions.SelectLayer
- Method VisioPageQueryExtensions.SelectOutgoingConnectors
- Method VisioPageQueryExtensions.SelectPathBetween
- Method VisioPageQueryExtensions.SelectShapes
- Method VisioPageQueryExtensions.SelectWithData
- Method VisioPageQueryExtensions.SelectWithData
- Method VisioPageQueryExtensions.SelectWithData
- Method VisioPageQueryExtensions.SelectWithHyperlink
- Method VisioPageQueryExtensions.SelectWithHyperlinks
- Method VisioPageQueryExtensions.SelectWithProtection
- Method VisioPageQueryExtensions.SelectWithProtection
- Method VisioPageQueryExtensions.SelectWithShapeData
- Method VisioPageQueryExtensions.SelectWithShapeData
- Method VisioPageQueryExtensions.SelectWithShapeData
- Method VisioPageQueryExtensions.SelectWithUserCell
- Method VisioPageQueryExtensions.SelectWithUserCell
- Method VisioPageQueryExtensions.ShapesByMaster
- Method VisioPageQueryExtensions.ShapesByName
- Method VisioPageQueryExtensions.ShapesByNameU
- Method VisioPageQueryExtensions.ShapesContainedIn
- Method VisioPageQueryExtensions.ShapesContainedIn
- Method VisioPageQueryExtensions.ShapesContainingText
- Method VisioPageQueryExtensions.ShapesInLayer
- Method VisioPageQueryExtensions.ShapesIntersecting
- Method VisioPageQueryExtensions.ShapesIntersecting
- Method VisioPageQueryExtensions.ShapesWithData
- Method VisioPageQueryExtensions.ShapesWithData
- Method VisioPageQueryExtensions.ShapesWithData
- Method VisioPageQueryExtensions.ShapesWithHyperlink
- Method VisioPageQueryExtensions.ShapesWithHyperlinks
- Method VisioPageQueryExtensions.ShapesWithProtection
- Method VisioPageQueryExtensions.ShapesWithProtection
- Method VisioPageQueryExtensions.ShapesWithShapeData
- Method VisioPageQueryExtensions.ShapesWithShapeData
- Method VisioPageQueryExtensions.ShapesWithShapeData
- Method VisioPageQueryExtensions.ShapesWithUserCell
- Method VisioPageQueryExtensions.ShapesWithUserCell
- Method VisioPngExportExtensions.SaveAsPng
- Method VisioPngExportExtensions.SaveAsPng
- Method VisioPngExportExtensions.ToPng
- Constructor VisioShapeSelection.VisioShapeSelection
- Extension method VisioShapeSelection.Duplicate
- Method VisioStencilMigrationExtensions.ApplyStencilMigration
- Method VisioStencilMigrationPlanApplyExtensions.ApplyStencilMigration
- Method VisioStencilMigrationPlanningExtensions.PlanStencilMigration
- Method VisioSvgExportExtensions.SaveAsSvg
- Method VisioSvgExportExtensions.SaveAsSvg
- Method VisioSvgExportExtensions.ToSvg
- Method VisioSwimlaneMaintenanceExtensions.FindSwimlaneLane
- Method VisioSwimlaneMaintenanceExtensions.FindSwimlanePhase
- Method VisioSwimlaneMaintenanceExtensions.GetSwimlaneActivities
- Method VisioSwimlaneMaintenanceExtensions.GetSwimlaneLanes
- Method VisioSwimlaneMaintenanceExtensions.GetSwimlanePhases
- Method VisioSwimlaneMaintenanceExtensions.MoveSwimlaneActivity
- Method VisioSwimlaneMaintenanceExtensions.RelayoutSwimlaneActivities
Constructors
public VisioPage(String name) #Initializes a new instance of the VisioPage class with default A4 size.
Parameters
- name System.String
- Name of the page.
Methods
public VisioShape AddCircle(Double x, Double y, Double diameter, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a circle shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- diameter System.Double
- Diameter of the circle.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created circle shape.
public VisioShape AddCircle(Double x, Double y, Double diameter, String text = null) #VisioShapeAdds a circle using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- diameter System.Double
- Diameter of the circle.
- text System.String = null
- Optional text.
Returns
The created circle shape.
public VisioConnector AddConnector(String id, VisioShape from, VisioShape to, ConnectorKind kind, VisioSide fromSide = Auto, VisioSide toSide = Auto) #VisioConnectorAdds a connector between two shapes.
Parameters
- id System.String
- Identifier of the connector.
- from OfficeIMO.Visio.VisioShape
- Shape from which the connector starts.
- to OfficeIMO.Visio.VisioShape
- Shape to which the connector ends.
- kind OfficeIMO.Visio.ConnectorKind
- Type of connector.
- fromSide OfficeIMO.Visio.VisioSide = Auto
- Preferred side on the source shape.
- toSide OfficeIMO.Visio.VisioSide = Auto
- Preferred side on the target shape.
Returns
The created connector.
public VisioConnector AddConnector(VisioShape from, VisioShape to, ConnectorKind kind = Dynamic, VisioSide fromSide = Auto, VisioSide toSide = Auto) #VisioConnectorAdds a connector between two shapes, optionally specifying side connection points.
Parameters
- from OfficeIMO.Visio.VisioShape
- Source shape.
- to OfficeIMO.Visio.VisioShape
- Target shape.
- kind OfficeIMO.Visio.ConnectorKind = Dynamic
- Connector kind (straight, curved, etc.).
- fromSide OfficeIMO.Visio.VisioSide = Auto
- Preferred side on the source shape.
- toSide OfficeIMO.Visio.VisioSide = Auto
- Preferred side on the target shape.
Returns
The created connector.
public VisioShape AddContainer(String id, String text, IEnumerable<VisioShape> members, VisioContainerOptions options = null) #VisioShapeAdds a Visio-native container shape around existing member shapes.
Parameters
- id System.String
- Container shape identifier.
- text System.String
- Container heading text.
- members System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- Shapes that should belong to the container.
- options OfficeIMO.Visio.VisioContainerOptions = null
- Optional container layout and style settings.
Returns
The created container shape.
public VisioShape AddContainer(String id, Double pinX, Double pinY, Double width, Double height, String text = null, VisioContainerOptions options = null) #VisioShapeAdds a Visio-native container shape at an explicit location and size.
Parameters
- id System.String
- Container shape identifier.
- pinX System.Double
- Container pin X coordinate.
- pinY System.Double
- Container pin Y coordinate.
- width System.Double
- Container width.
- height System.Double
- Container height.
- text System.String = null
- Container heading text.
- options OfficeIMO.Visio.VisioContainerOptions = null
- Optional style and semantic settings.
Returns
The created container shape.
public VisioShape AddData(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart data shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the data shape.
- height System.Double
- Height of the data shape.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created data shape.
public VisioShape AddData(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart data shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddDecision(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart decision shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the decision shape.
- height System.Double
- Height of the decision shape.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created decision shape.
public VisioShape AddDecision(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart decision shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddDiamond(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a diamond shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the diamond.
- height System.Double
- Height of the diamond.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created diamond shape.
public VisioShape AddDiamond(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a diamond using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the diamond.
- height System.Double
- Height of the diamond.
- text System.String = null
- Optional text.
Returns
The created diamond shape.
public VisioShape AddEllipse(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds an ellipse shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the ellipse.
- height System.Double
- Height of the ellipse.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created ellipse shape.
public VisioShape AddEllipse(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds an ellipse using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the ellipse.
- height System.Double
- Height of the ellipse.
- text System.String = null
- Optional text.
Returns
The created ellipse shape.
public VisioShape AddHexagon(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a hexagon shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the hexagon.
- height System.Double
- Height of the hexagon.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created hexagon shape.
public VisioShape AddHexagon(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a hexagon shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioLayer AddLayer(String name, String nameU = null) #VisioLayerAdds a page layer, or returns the existing layer with the same name or universal name.
Parameters
- name System.String
- Layer display name.
- nameU System.String = null
- Optional universal name.
public VisioShape AddManualOperation(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart manual operation shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the manual operation shape.
- height System.Double
- Height of the manual operation shape.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created manual operation shape.
public VisioShape AddManualOperation(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart manual operation shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddOffPageReference(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart off-page reference shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the off-page reference shape.
- height System.Double
- Height of the off-page reference shape.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created off-page reference shape.
public VisioShape AddOffPageReference(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart off-page reference shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddParallelogram(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a parallelogram shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the parallelogram.
- height System.Double
- Height of the parallelogram.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created parallelogram shape.
public VisioShape AddParallelogram(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a parallelogram shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddPentagon(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a pentagon shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the pentagon.
- height System.Double
- Height of the pentagon.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created pentagon shape.
public VisioShape AddPentagon(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a pentagon shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddPreparation(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart preparation shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the preparation shape.
- height System.Double
- Height of the preparation shape.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created preparation shape.
public VisioShape AddPreparation(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart preparation shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddProcess(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a flowchart process shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the process box.
- height System.Double
- Height of the process box.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created process shape.
public VisioShape AddProcess(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a flowchart process shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddRectangle(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a rectangle shape.
Parameters
- x System.Double
- X coordinate of the shape origin.
- y System.Double
- Y coordinate of the shape origin.
- width System.Double
- Width of the rectangle.
- height System.Double
- Height of the rectangle.
- text System.String = null
- Optional text placed on the shape.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
Returns
The created rectangle shape.
public VisioShape AddRectangle(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a rectangle shape using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the rectangle.
- height System.Double
- Height of the rectangle.
- text System.String = null
- Optional text.
Returns
The created rectangle shape.
public VisioShape AddShape(String id, String masterNameU, Double x, Double y, Double w, Double h, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a shape to the page.
Parameters
- id System.String
- Identifier of the shape.
- master OfficeIMO.Visio.VisioMaster
- Master associated with the shape.
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- w System.Double
- Width of the shape.
- h System.Double
- Height of the shape.
- text System.String = null
- Optional text.
- unit System.Nullable{OfficeIMO.Visio.VisioMeasurementUnit} = Inches
- Optional measurement unit. When omitted, values are interpreted using the page DefaultUnit.
Returns
The created shape.
AddShape(System.String id, System.String masterNameU, System.Double x, System.Double y, System.Double w, System.Double h, System.String text, OfficeIMO.Visio.VisioMeasurementUnit unit) #Adds a shape using a document-registered master by its NameU.
Parameters
- id System.String
- Identifier of the shape.
- masterNameU System.String
- Registered master universal name.
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- w System.Double
- Width.
- h System.Double
- Height.
- text System.String
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit
- Measurement unit for the provided values.
Returns
The created shape.
public VisioShape AddShape(String id, String masterNameU, Double x, Double y, Double w, Double h, String text = null) #VisioShapeAdds a shape using the page DefaultUnit and a document-registered master.
Parameters
- id System.String
- masterNameU System.String
- x System.Double
- y System.Double
- w System.Double
- h System.Double
- text System.String = null
public VisioShape AddSquare(Double x, Double y, Double size, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a square shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- size System.Double
- Width and height of the square.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created square shape.
public VisioShape AddSquare(Double x, Double y, Double size, String text = null) #VisioShapeAdds a square using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- size System.Double
- Width and height of the square.
- text System.String = null
- Optional text.
Returns
The created square shape.
public VisioShape AddTextBox(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds an editable text box without a visible border or fill.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the text box.
- height System.Double
- Height of the text box.
- text System.String = null
- Text to place in the box.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created text box shape.
public VisioShape AddTextBox(String id, Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds an editable text box with a caller-provided shape id and without a visible border or fill.
Parameters
- id System.String
- Shape identifier.
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the text box.
- height System.Double
- Height of the text box.
- text System.String = null
- Text to place in the box.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created text box shape.
public VisioShape AddTextBox(String id, Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds an editable text box with a caller-provided shape id and without a visible border or fill using the page DefaultUnit.
Parameters
- id System.String
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddTextBox(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds an editable text box without a visible border or fill using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioPage AddToLayer(String layerName, VisioConnector connector) #VisioPageAdds a shape to a page layer, creating the layer if needed.
Parameters
- layerName System.String
- Layer name.
- shape OfficeIMO.Visio.VisioShape
- Shape to assign.
AddToLayer(System.String layerName, OfficeIMO.Visio.VisioConnector connector) #Adds a connector to a page layer, creating the layer if needed.
Parameters
- layerName System.String
- Layer name.
- connector OfficeIMO.Visio.VisioConnector
- Connector to assign.
public VisioShape AddTrapezoid(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a trapezoid shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the trapezoid.
- height System.Double
- Height of the trapezoid.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created trapezoid shape.
public VisioShape AddTrapezoid(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a trapezoid shape using the page DefaultUnit.
Parameters
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public VisioShape AddTriangle(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #VisioShapeAdds a triangle shape.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the triangle's bounding box.
- height System.Double
- Height of the triangle's bounding box.
- text System.String = null
- Optional text.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The created triangle shape.
public VisioShape AddTriangle(Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a triangle using the page DefaultUnit.
Parameters
- x System.Double
- X coordinate.
- y System.Double
- Y coordinate.
- width System.Double
- Width of the triangle's bounding box.
- height System.Double
- Height of the triangle's bounding box.
- text System.String = null
- Optional text.
Returns
The created triangle shape.
public VisioPage ClearBackgroundPage() #VisioPageRemoves the applied background page reference.
public VisioPage ClearConnectorRoutingPolicy() #VisioPageClears page-level connector routing and line-jump policy cells so Visio can use template defaults.
public VisioPage ClearConnectorSpacing() #VisioPageClears page-level connector spacing cells so Visio can use template defaults.
public VisioPage ClearLayoutGridPolicy() #VisioPageClears Visio layout grid enablement and sizing cells so Visio can use template defaults.
public VisioPage ClearLayoutGridSizing() #VisioPageClears Visio layout grid sizing cells so Visio can use template defaults.
public VisioPage ClearPlacementPolicy() #VisioPageClears page-level placement policy cells so Visio can use template defaults.
public VisioLayer FindLayer(String nameOrNameU) #VisioLayerFinds a layer by display name or universal name.
Parameters
- nameOrNameU System.String
- Layer name to find.
public VisioPage Grid(Boolean visible, Boolean snap) #VisioPageConfigures grid visibility and snapping.
Parameters
- visible System.Boolean
- Whether the grid is visible.
- snap System.Boolean
- Whether snapping is enabled.
Returns
The current page.
public Void ReconnectConnector(VisioConnector connector, VisioShape newFrom, VisioShape newTo, VisioSide fromSide = Auto, VisioSide toSide = Auto) #VoidReconnects both ends of an existing connector.
Parameters
- connector OfficeIMO.Visio.VisioConnector
- newFrom OfficeIMO.Visio.VisioShape
- newTo OfficeIMO.Visio.VisioShape
- fromSide OfficeIMO.Visio.VisioSide = Auto
- toSide OfficeIMO.Visio.VisioSide = Auto
public Void ReconnectConnectorEnd(VisioConnector connector, VisioShape newTo, VisioSide side = Auto) #VoidReconnects the end of an existing connector to a different shape.
Parameters
- connector OfficeIMO.Visio.VisioConnector
- newTo OfficeIMO.Visio.VisioShape
- side OfficeIMO.Visio.VisioSide = Auto
public Void ReconnectConnectorStart(VisioConnector connector, VisioShape newFrom, VisioSide side = Auto) #VoidReconnects the start of an existing connector to a different shape.
Parameters
- connector OfficeIMO.Visio.VisioConnector
- newFrom OfficeIMO.Visio.VisioShape
- side OfficeIMO.Visio.VisioSide = Auto
public Void ReparentShape(VisioShape shape, VisioShape newParent, Int32 childIndex = -1) #VoidMoves a shape from its current location in the page hierarchy into the provided group shape.
Parameters
- shape OfficeIMO.Visio.VisioShape
- The shape to move.
- newParent OfficeIMO.Visio.VisioShape
- The group that should own the shape after the move.
- childIndex System.Int32 = -1
- Optional insertion index within the target group's children. Use -1 to append.
public Void ResetDrawingScale() #VoidRemoves any custom drawing scale override and reverts to ScaleMeasurementUnit.
public Void ResetPageScale() #VoidRemoves any custom page scale override and reverts to ScaleMeasurementUnit.
public IReadOnlyList<VisioConnector> RetargetConnectors(VisioShape oldShape, VisioShape newShape, VisioConnectorEndpointScope endpointScope = Both, VisioSide fromSide = Auto, VisioSide toSide = Auto) #IReadOnlyList<VisioConnector>Retargets all connector endpoints on this page that currently reference one shape to another.
Parameters
- oldShape OfficeIMO.Visio.VisioShape
- The existing shape referenced by matching connectors.
- newShape OfficeIMO.Visio.VisioShape
- The replacement shape that matching connectors should reference.
- endpointScope OfficeIMO.Visio.VisioConnectorEndpointScope = Both
- Controls whether start points, end points, or both are updated.
- fromSide OfficeIMO.Visio.VisioSide = Auto
- The side to glue to when a start point is updated.
- toSide OfficeIMO.Visio.VisioSide = Auto
- The side to glue to when an end point is updated.
Returns
The connectors that were updated.
public VisioPage SetBackgroundPage(VisioPage backgroundPage) #VisioPageApplies a reusable Visio background page to this page.
Parameters
- backgroundPage OfficeIMO.Visio.VisioPage
- Background page to apply.
public VisioPage SetConnectorSpacing(Double lineToLine, Double lineToNode, VisioMeasurementUnit unit = Inches) #VisioPageSets page-level connector and connector-to-shape spacing used by Visio routing.
Parameters
- lineToLine System.Double
- Horizontal and vertical connector-to-connector clearance.
- lineToNode System.Double
- Horizontal and vertical connector-to-shape clearance.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage SetConnectorSpacing(Double lineToLineX, Double lineToLineY, Double lineToNodeX, Double lineToNodeY, VisioMeasurementUnit unit = Inches) #VisioPageSets individual page-level connector routing clearances used by Visio.
Parameters
- lineToLineX System.Double
- Horizontal connector-to-connector clearance.
- lineToLineY System.Double
- Vertical connector-to-connector clearance.
- lineToNodeX System.Double
- Horizontal connector-to-shape clearance.
- lineToNodeY System.Double
- Vertical connector-to-shape clearance.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage SetLayoutGridSizing(Double blockSize, Double avenueSize, VisioMeasurementUnit unit = Inches) #VisioPageSets Visio layout grid block sizes and spacing values.
Parameters
- blockSize System.Double
- Horizontal and vertical average shape block size.
- avenueSize System.Double
- Horizontal and vertical spacing between shapes.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage SetLayoutGridSizing(Double blockSizeX, Double blockSizeY, Double avenueSizeX, Double avenueSizeY, VisioMeasurementUnit unit = Inches) #VisioPageSets individual Visio layout grid block sizes and spacing values.
Parameters
- blockSizeX System.Double
- Horizontal average shape block size.
- blockSizeY System.Double
- Vertical average shape block size.
- avenueSizeX System.Double
- Horizontal spacing between shapes.
- avenueSizeY System.Double
- Vertical spacing between shapes.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage SetMargins(Double margin, VisioMeasurementUnit unit = Inches) #VisioPageSets all print margins to the same value.
Parameters
- margin System.Double
- Margin value.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided value.
public VisioPage SetMargins(Double horizontal, Double vertical, VisioMeasurementUnit unit = Inches) #VisioPageSets horizontal and vertical print margins.
Parameters
- horizontal System.Double
- Left and right margin value.
- vertical System.Double
- Top and bottom margin value.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage SetMargins(Double left, Double right, Double top, Double bottom, VisioMeasurementUnit unit = Inches) #VisioPageSets individual print margins.
Parameters
- left System.Double
- Left margin.
- right System.Double
- Right margin.
- top System.Double
- Top margin.
- bottom System.Double
- Bottom margin.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit for the provided values.
public VisioPage Size(Double w, Double h, VisioMeasurementUnit unit = Inches) #VisioPageSets the page size.
Parameters
- w System.Double
- Width of the page.
- h System.Double
- Height of the page.
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
- Measurement unit.
Returns
The current page.
public IReadOnlyList<VisioShape> UngroupShape(VisioShape group) #IReadOnlyList<VisioShape>Removes a group shape and promotes its children into the group's former position.
Parameters
- group OfficeIMO.Visio.VisioShape
- The group to ungroup.
Returns
The children that were promoted.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Int32 Id { get; set; } #Gets the identifier of the page within the document.
public String NameU { get; set; } #Gets or sets the universal name of the page.
public Double ViewScale { get; set; } #Gets or sets the view scale of the page.
public Double ViewCenterX { get; set; } #Gets or sets the horizontal center of the view.
public Double ViewCenterY { get; set; } #Gets or sets the vertical center of the view.
public Double Width { get; set; } #Gets or sets the page width in inches.
public Double WidthCentimeters { get; set; } #Gets or sets the page width in centimeters.
public Double Height { get; set; } #Gets or sets the page height in inches.
public Double HeightCentimeters { get; set; } #Gets or sets the page height in centimeters.
public VisioMeasurementUnit DefaultUnit { get; set; } #Default measurement unit for positions and sizes on this page. New shape-adding overloads use this unit implicitly.
public VisioMeasurementUnit ScaleMeasurementUnit { get; set; } #Measurement unit used to compute page and drawing scales when explicit overrides are not supplied. Defaults to inches and typically mirrors DefaultUnit.
public VisioScaleSetting PageScale { get; set; } #Gets or sets the page scale (the ratio between page units and real-world units).
public VisioScaleSetting DrawingScale { get; set; } #Gets or sets the drawing scale (the ratio between drawing units and real-world units).
public Double PageWidth { get; set; } #Obsolete("Use Width instead")Gets or sets the page width. Use Width instead.
public Double PageHeight { get; set; } #Obsolete("Use Height instead")Gets or sets the page height. Use Height instead.
public Boolean GridVisible { get; set; } #Gets or sets a value indicating whether the grid is visible.
public Boolean Snap { get; set; } #Gets or sets a value indicating whether snapping to grid is enabled.
public Boolean PageLockReplace { get; set; } #Gets or sets whether Visio should prevent replacing this page.
public Boolean PageLockDuplicate { get; set; } #Gets or sets whether Visio should prevent duplicating this page.
public VisioDrawingSizeType DrawingSizeType { get; set; } #Gets or sets how Visio determines this page's drawing size.
public Boolean AutoResizeDrawing { get; set; } #Gets or sets whether Visio automatically resizes the drawing page to fit the diagram.
public Boolean AllowShapeSplitting { get; set; } #Gets or sets whether Visio can automatically split shapes on this page.
public VisioPageUiVisibility UiVisibility { get; set; } #Gets or sets whether the page name is shown in Visio UI surfaces such as page tabs.
public Nullable<VisioPlacementStyle> PlacementStyle { get; set; } #Gets or sets the page-level placement style Visio uses when laying out shapes.
public Nullable<VisioPlacementDepth> PlacementDepth { get; set; } #Gets or sets the placement analysis depth Visio uses during page layout.
public Nullable<VisioPlacementFlip> PlacementFlip { get; set; } #Gets or sets how Visio may flip or rotate shapes during page layout.
public Nullable<Boolean> MoveShapesAwayOnDrop { get; set; } #Gets or sets whether Visio should move nearby placeable shapes away when dropping a shape.
public Nullable<Boolean> ResizePageToFitLayout { get; set; } #Gets or sets whether Visio should enlarge the page after laying out shapes.
public Nullable<Boolean> EnableLayoutGrid { get; set; } #Gets or sets whether Visio uses its internal layout grid when arranging shapes on this page.
public Nullable<VisioPageRouteStyle> ConnectorRouteStyle { get; set; } #Gets or sets the page-level routing style for connectors without a local routing style.
public Nullable<VisioLineRouteExtension> ConnectorRouteAppearance { get; set; } #Gets or sets the default routed connector appearance on this page.
public Nullable<VisioLineJumpStyle> LineJumpStyle { get; set; } #Gets or sets the line jump style for connectors without a local jump style.
public Nullable<VisioLineJumpCode> LineJumpCode { get; set; } #Gets or sets which connectors receive line jumps on this page.
public Nullable<VisioHorizontalLineJumpDirection> HorizontalLineJumpDirection { get; set; } #Gets or sets the page default line jump direction for horizontal dynamic connectors.
public Nullable<VisioVerticalLineJumpDirection> VerticalLineJumpDirection { get; set; } #Gets or sets the page default line jump direction for vertical dynamic connectors.
public Nullable<Double> LineToLineX { get; } #Gets the horizontal clearance between connectors in inches, if explicitly set.
public Nullable<Double> LineToLineY { get; } #Gets the vertical clearance between connectors in inches, if explicitly set.
public Nullable<Double> LineToNodeX { get; } #Gets the horizontal clearance between connectors and shapes in inches, if explicitly set.
public Nullable<Double> LineToNodeY { get; } #Gets the vertical clearance between connectors and shapes in inches, if explicitly set.
public Nullable<Double> LayoutBlockSizeX { get; } #Gets the horizontal average shape block size in inches, if explicitly set.
public Nullable<Double> LayoutBlockSizeY { get; } #Gets the vertical average shape block size in inches, if explicitly set.
public Nullable<Double> LayoutAvenueSizeX { get; } #Gets the horizontal spacing between shapes in inches, if explicitly set.
public Nullable<Double> LayoutAvenueSizeY { get; } #Gets the vertical spacing between shapes in inches, if explicitly set.
public Nullable<VisioPagePrintOrientation> PrintOrientation { get; set; } #Gets or sets the print orientation. When null, OfficeIMO keeps Visio's default unless non-default page metadata is required.
public Double LeftMargin { get; } #Gets the left print margin in inches.
public Double RightMargin { get; } #Gets the right print margin in inches.
public Double TopMargin { get; } #Gets the top print margin in inches.
public Double BottomMargin { get; } #Gets the bottom print margin in inches.
public Boolean IsBackground { get; set; } #Gets or sets whether this page is a Visio background page.
public VisioPage BackgroundPage { get; set; } #Gets the background page applied to this foreground page, if any.
public IList<VisioShape> Shapes { get; } #Shapes placed on the page.
public IList<VisioConnector> Connectors { get; } #Connectors placed on the page.
public IList<VisioLayer> Layers { get; } #Layers defined on this page.
public IList<VisioComment> Comments { get; } #Native Visio comments attached to this page.
Extension Methods
public static VisioShape AddCallout(VisioPage page, VisioShape target, String text, Double pinX, Double pinY, VisioCalloutOptions options = null) #VisioShapeAdds a callout near a target shape using an automatically assigned shape identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that receives the callout.
- target OfficeIMO.Visio.VisioShape
- Shape being annotated.
- text System.String
- Callout text.
- pinX System.Double
- Callout pin X coordinate.
- pinY System.Double
- Callout pin Y coordinate.
- options OfficeIMO.Visio.VisioCalloutOptions = null
- Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String text, VisioSide placement, Double gap = 0.35, VisioCalloutOptions options = null) #VisioShapeAdds a callout near a target shape using an automatically assigned shape identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that receives the callout.
- target OfficeIMO.Visio.VisioShape
- Shape being annotated.
- text System.String
- Callout text.
- pinX System.Double
- Callout pin X coordinate.
- pinY System.Double = 0.35
- Callout pin Y coordinate.
- options OfficeIMO.Visio.VisioCalloutOptions = null
- Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String id, String text, Double pinX, Double pinY, VisioCalloutOptions options = null) #VisioShapeAdds a callout near a target shape using an explicit shape identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that receives the callout.
- target OfficeIMO.Visio.VisioShape
- Shape being annotated.
- id System.String
- Callout shape identifier.
- text System.String
- Callout text.
- pinX System.Double
- Callout pin X coordinate.
- pinY System.Double
- Callout pin Y coordinate.
- options OfficeIMO.Visio.VisioCalloutOptions = null
- Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String id, String text, VisioSide placement, Double gap = 0.35, VisioCalloutOptions options = null) #VisioShapeAdds a callout near a target shape using an explicit shape identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that receives the callout.
- target OfficeIMO.Visio.VisioShape
- Shape being annotated.
- id System.String
- Callout shape identifier.
- text System.String
- Callout text.
- pinX System.Double
- Callout pin X coordinate.
- pinY System.Double = 0.35
- Callout pin Y coordinate.
- options OfficeIMO.Visio.VisioCalloutOptions = null
- Optional callout options.
public static VisioComment AddComment(VisioPage page, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #VisioCommentAdds a page-level native Visio comment.
Parameters
- page OfficeIMO.Visio.VisioPage
- text System.String
- authorName System.String = null
- authorInitials System.String = null
- options OfficeIMO.Visio.VisioCommentOptions = null
public static VisioComment AddComment(VisioPage page, VisioShape target, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #VisioCommentAdds a native Visio comment to a shape on the page.
Parameters
- page OfficeIMO.Visio.VisioPage
- target OfficeIMO.Visio.VisioShape
- text System.String
- authorName System.String = null
- authorInitials System.String = null
- options OfficeIMO.Visio.VisioCommentOptions = null
public static VisioComment AddCommentToShape(VisioPage page, String shapeId, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #VisioCommentAdds a native Visio comment to a shape or connector by identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- shapeId System.String
- text System.String
- authorName System.String = null
- authorInitials System.String = null
- options OfficeIMO.Visio.VisioCommentOptions = null
public static IReadOnlyList<VisioShape> AddDataGraphics(VisioPage page, VisioShape target, VisioDataGraphic dataGraphic) #IReadOnlyList<VisioShape>Adds visible data graphics for one target shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the target shape.
- target OfficeIMO.Visio.VisioShape
- Shape whose Shape Data values should be visualized.
- dataGraphic OfficeIMO.Visio.VisioDataGraphic
- Data graphic definition.
public static IReadOnlyList<VisioShape> AddStencilGallery(VisioPage page, VisioStencilCatalog catalog, VisioStencilGalleryOptions options = null) #IReadOnlyList<VisioShape>Adds a contact-sheet gallery for a stencil catalog to the page.
Parameters
- page OfficeIMO.Visio.VisioPage
- Target page.
- catalog OfficeIMO.Visio.Stencils.VisioStencilCatalog
- Stencil catalog to render.
- options OfficeIMO.Visio.Stencils.VisioStencilGalleryOptions = null
- Optional gallery layout and visual options.
Returns
The stencil instance shapes placed in the gallery.
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, String text = null) #VisioShapeAdds a stencil shape using its default size and the page default measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- text System.String = null
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, String text, VisioMeasurementUnit unit) #VisioShapeAdds a stencil shape using its default size and an explicit measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- text System.String
- unit OfficeIMO.Visio.VisioMeasurementUnit
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a stencil shape using an explicit size and the page default measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, Double width, Double height, String text, VisioMeasurementUnit unit) #VisioShapeAdds a stencil shape using an explicit size and measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String
- unit OfficeIMO.Visio.VisioMeasurementUnit
public static VisioShape AddStencilShape(VisioPage page, VisioStencilCatalog catalog, String stencilIdOrName, String id, Double x, Double y, String text = null) #VisioShapeAdds a stencil shape using its default size and an explicit measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- text System.String
- unit OfficeIMO.Visio.VisioMeasurementUnit = null
public static VisioShape AddStencilShape(VisioPage page, VisioStencilCatalog catalog, String stencilIdOrName, String id, Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a stencil shape using an explicit size and measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String
- unit OfficeIMO.Visio.VisioMeasurementUnit = null
public static VisioShape AddStencilShape(VisioPage page, String stencilIdOrName, String id, Double x, Double y, String text = null) #VisioShapeAdds a stencil shape using its default size and the page default measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- text System.String = null
public static VisioShape AddStencilShape(VisioPage page, String stencilIdOrName, String id, Double x, Double y, Double width, Double height, String text = null) #VisioShapeAdds a stencil shape using an explicit size and the page default measurement unit.
Parameters
- page OfficeIMO.Visio.VisioPage
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
- id System.String
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- text System.String = null
public static VisioShape AddToContainer(VisioPage page, VisioShape container, VisioShape member, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #VisioShapeAdds one member shape to a Visio-native container and optionally resizes the container around all current members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static VisioShape AddToContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #VisioShapeAdds one member shape to a Visio-native container and optionally resizes the container around all current members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static IReadOnlyList<VisioShape> AllShapes(VisioPage page) #IReadOnlyList<VisioShape>Returns all shapes on the page, including shapes nested inside groups.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static IReadOnlyList<VisioDiagramQualityIssue> AnalyzeVisualQuality(VisioPage page, VisioDiagramQualityOptions options = null) #IReadOnlyList<VisioDiagramQualityIssue>Analyzes every page in a document for common visual quality issues.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document to analyze.
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
- Analysis options.
public static VisioShape ApplyContainerOptions(VisioPage page, VisioShape container, VisioContainerOptions options, Boolean refit = false) #VisioShapeApplies native container metadata and visual style to an existing Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to update.
- options OfficeIMO.Visio.VisioContainerOptions
- Container metadata and style options.
- refit System.Boolean = false
- Whether the container should be refit around current members after metadata is applied.
public static VisioStencilMigrationResult ApplyStencilMigration(VisioPage page, VisioStencilMigrationMap map) #VisioStencilMigrationResultApplies a stencil migration map to every foreground page in the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- map OfficeIMO.Visio.VisioStencilMigrationMap
public static VisioStencilMigrationResult ApplyStencilMigration(VisioPage page, VisioStencilMigrationPlan plan, VisioStencilMigrationMap map) #VisioStencilMigrationResultApplies a previously reviewed stencil migration plan to a document. The current document must still match the planned pages, shapes, match rules, and replacement stencils.
Parameters
- document OfficeIMO.Visio.VisioDocument
- Document to update.
- plan OfficeIMO.Visio.VisioStencilMigrationPlan
- Reviewed migration plan.
- map OfficeIMO.Visio.VisioStencilMigrationMap
- Migration map used to create the plan.
public static IReadOnlyList<VisioShape> Callouts(VisioPage page) #IReadOnlyList<VisioShape>Returns shapes marked as OfficeIMO callouts or annotations.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioPage CenterContent(VisioPage page) #VisioPageCenters top-level page shapes within the current page size.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to update.
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, VisioShape target) #IReadOnlyList<VisioComment>Returns comments that target the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- target OfficeIMO.Visio.VisioShape
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, String shapeId) #IReadOnlyList<VisioComment>Returns comments that target the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- target OfficeIMO.Visio.VisioShape
public static VisioShape ConfigureContainer(VisioPage page, VisioShape container, Action<VisioContainerOptions> configure, Boolean refit = false) #VisioShapeUpdates native container metadata and visual style using a callback initialized from the current container state.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to update.
- configure System.Action{OfficeIMO.Visio.VisioContainerOptions}
- Option callback.
- refit System.Boolean = false
- Whether the container should be refit around current members after metadata is applied.
public static IReadOnlyList<VisioShape> ConnectedComponent(VisioPage page, VisioShape shape, Boolean includeStart = true) #IReadOnlyList<VisioShape>Returns every shape reachable from the provided shape through connectors.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Starting shape.
- includeStart System.Boolean = true
- Whether the starting shape should be included in the returned component.
public static IReadOnlyList<VisioConnector> ConnectedConnectors(VisioPage page, VisioShape shape) #IReadOnlyList<VisioConnector>Returns connectors that either start or end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to or from.
public static IReadOnlyList<VisioShape> ConnectedShapes(VisioPage page, VisioShape shape) #IReadOnlyList<VisioShape>Returns shapes connected to the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape whose neighbors should be returned.
public static IReadOnlyList<VisioConnector> ConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioConnector>Returns connectors assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioConnector> ConnectorsWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioConnector>Returns connectors that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioConnector> ConnectorsWithHyperlinks(VisioPage page) #IReadOnlyList<VisioConnector>Returns connectors that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static IReadOnlyList<VisioConnector> ConnectorsWithProtection(VisioPage page) #IReadOnlyList<VisioConnector>Returns connectors that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static IReadOnlyList<VisioConnector> ConnectorsWithProtection(VisioPage page, Func<VisioProtection, Boolean> predicate) #IReadOnlyList<VisioConnector>Returns connectors whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean}
- Protection predicate.
public static IReadOnlyList<VisioShape> Containers(VisioPage page) #IReadOnlyList<VisioShape>Returns shapes marked as Visio-native containers.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioPage Duplicate(VisioPage page, String name = null) #VisioPageDuplicates this page in its owner document.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to duplicate.
- name System.String = null
- Optional name for the duplicate. When omitted, a unique copy name is generated.
Returns
The duplicated page.
public static VisioPage Duplicate(VisioPage page, VisioPageDuplicationOptions options) #VisioPageDuplicates this page in its owner document.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to duplicate.
- name System.String = null
- Optional name for the duplicate. When omitted, a unique copy name is generated.
Returns
The duplicated page.
public static VisioShapeSelection DuplicateShapes(VisioPage page, IEnumerable<VisioShape> shapes, Double offsetX = 0.35, Double offsetY = -0.35, Boolean includeInternalConnectors = true) #VisioShapeSelectionDuplicates shapes on the same page and optionally copies connectors whose endpoints are both duplicated.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the shapes.
- shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- Shapes to duplicate. Nested children are copied with their selected ancestor.
- offsetX System.Double = 0.35
- Horizontal offset for duplicated top-level shapes and page-coordinate routing points.
- offsetY System.Double = -0.35
- Vertical offset for duplicated top-level shapes and page-coordinate routing points.
- includeInternalConnectors System.Boolean = true
- Whether connectors between duplicated shapes should also be copied.
Returns
A selection containing the duplicated root shapes.
public static VisioShapeSelection DuplicateShapes(VisioPage page, IEnumerable<VisioShape> shapes, VisioShapeDuplicationOptions options) #VisioShapeSelectionDuplicates shapes on the same page and optionally copies connectors whose endpoints are both duplicated.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the shapes.
- shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- Shapes to duplicate. Nested children are copied with their selected ancestor.
- options OfficeIMO.Visio.VisioShapeDuplicationOptions
- Optional duplication settings.
Returns
A selection containing the duplicated root shapes.
public static VisioPage EnsureVisualQuality(VisioPage page, VisioDiagramQualityOptions options = null, VisioDiagramQualityIssueSeverity minimumSeverity = Warning) #VisioPageThrows when a document contains visual quality issues at or above the requested severity.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
- minimumSeverity OfficeIMO.Visio.VisioDiagramQualityIssueSeverity = Warning
public static VisioComment FindComment(VisioPage page, Int32 commentId) #VisioCommentFinds a native Visio comment by its page-scoped identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- commentId System.Int32
public static VisioShape FindShapeById(VisioPage page, String id) #VisioShapeFinds a shape by identifier, including shapes nested inside groups.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- id System.String
- Shape identifier.
public static VisioSwimlaneLane FindSwimlaneLane(VisioPage page, String laneId) #VisioSwimlaneLaneFinds a swimlane lane by identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- laneId System.String
public static VisioSwimlanePhase FindSwimlanePhase(VisioPage page, String phaseId) #VisioSwimlanePhaseFinds a swimlane phase by identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- phaseId System.String
public static VisioPage FitToContent(VisioPage page, Double margin = 0.5, Boolean resizePage = true) #VisioPageMoves top-level page shapes so content starts at the requested margin and optionally resizes the page to fit.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to update.
- margin System.Double = 0.5
- Margin in inches around content.
- resizePage System.Boolean = true
- Whether to resize the page around the content.
public static VisioPage FitToContent(VisioPage page, Double horizontalMargin, Double verticalMargin, Boolean resizePage = true) #VisioPageMoves top-level page shapes so content starts at the requested margins and optionally resizes the page to fit.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to update.
- horizontalMargin System.Double
- Horizontal margin in inches.
- verticalMargin System.Double
- Vertical margin in inches.
- resizePage System.Boolean = true
- Whether to resize the page around the content.
public static VisioContainerInfo GetContainerInfo(VisioPage page, VisioShape container) #VisioContainerInfoGets typed metadata and membership information for a Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static IReadOnlyList<VisioShape> GetContainerMembers(VisioPage page, VisioShape container) #IReadOnlyList<VisioShape>Gets the shapes currently referenced by a Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static VisioContainerOptions GetContainerOptions(VisioPage page, VisioShape container) #VisioContainerOptionsGets editable options initialized from a Visio-native container's current metadata and visual style.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static VisioShapeBounds GetContentBounds(VisioPage page, Boolean includeGroupChildren = false, Boolean includeConnectors = true) #VisioShapeBoundsGets bounds of visible page content, including shapes, explicit connector routes, and connector label boxes.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to inspect.
- includeGroupChildren System.Boolean = false
- Whether nested group children should be included using their stored coordinates.
- includeConnectors System.Boolean = true
- Whether connector waypoints and label boxes should be included.
public static IReadOnlyList<VisioSwimlaneActivityPlacement> GetSwimlaneActivities(VisioPage page) #IReadOnlyList<VisioSwimlaneActivityPlacement>Finds swimlane activities and their current lane/phase placement.
Parameters
- page OfficeIMO.Visio.VisioPage
public static IReadOnlyList<VisioSwimlaneLane> GetSwimlaneLanes(VisioPage page) #IReadOnlyList<VisioSwimlaneLane>Finds swimlane lanes on the page, using OfficeIMO semantic metadata first and generated IDs/stencil metadata as a fallback.
Parameters
- page OfficeIMO.Visio.VisioPage
public static IReadOnlyList<VisioSwimlanePhase> GetSwimlanePhases(VisioPage page) #IReadOnlyList<VisioSwimlanePhase>Finds swimlane phase columns on the page, using OfficeIMO semantic metadata first and generated IDs/stencil metadata as a fallback.
Parameters
- page OfficeIMO.Visio.VisioPage
public static VisioDiagramQualityReport GetVisualQualityReport(VisioPage page, VisioDiagramQualityOptions options = null) #VisioDiagramQualityReportCreates a visual quality report for every page in a document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioDiagramQualityOptions = null
public static IReadOnlyList<VisioConnector> IncomingConnectors(VisioPage page, VisioShape shape) #IReadOnlyList<VisioConnector>Returns connectors that end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to.
public static VisioPage MoveSwimlaneActivity(VisioPage page, String activityId, String laneId, String phaseId, VisioSwimlaneRelayoutOptions options = null) #VisioPageMoves a swimlane activity to a target lane/phase cell and relayouts the affected swimlane activities.
Parameters
- page OfficeIMO.Visio.VisioPage
- activityId System.String
- laneId System.String
- phaseId System.String
- options OfficeIMO.Visio.VisioSwimlaneRelayoutOptions = null
public static IReadOnlyList<VisioConnector> OutgoingConnectors(VisioPage page, VisioShape shape) #IReadOnlyList<VisioConnector>Returns connectors that start at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected from.
public static IReadOnlyList<VisioShape> PathBetween(VisioPage page, VisioShape from, VisioShape to, Boolean includeEndpoints = true) #IReadOnlyList<VisioShape>Returns the shortest shape path between two connected shapes, or an empty list when no path exists.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- from OfficeIMO.Visio.VisioShape
- Starting shape.
- to OfficeIMO.Visio.VisioShape
- Target shape.
- includeEndpoints System.Boolean = true
- Whether the starting and target shapes should be included.
public static VisioStencilMigrationPlan PlanStencilMigration(VisioPage page, VisioStencilMigrationMap map) #VisioStencilMigrationPlanPlans a stencil migration map for every foreground page in the document without modifying the document.
Parameters
- document OfficeIMO.Visio.VisioDocument
- map OfficeIMO.Visio.VisioStencilMigrationMap
public static VisioPage PolishDiagram(VisioPage page, VisioDiagramPolishOptions options = null) #VisioPageApplies a deterministic cleanup pass to a page: optional text fitting, connector label fitting, label collision cleanup, and page fitting.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to polish.
- options OfficeIMO.Visio.VisioDiagramPolishOptions = null
- Optional polish settings.
public static VisioShape RefitContainer(VisioPage page, VisioShape container, VisioContainerOptions options = null) #VisioShapeResizes a Visio-native container so it encloses its current typed members.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to resize.
- options OfficeIMO.Visio.VisioContainerOptions = null
- Optional margin and heading settings used for the calculated bounds.
public static VisioPage RelayoutSwimlaneActivities(VisioPage page, VisioSwimlaneRelayoutOptions options = null) #VisioPageRe-centers swimlane activities inside their lane/phase cells, stacking multiple activities deterministically.
Parameters
- page OfficeIMO.Visio.VisioPage
- options OfficeIMO.Visio.VisioSwimlaneRelayoutOptions = null
public static Boolean RemoveComment(VisioPage page, VisioComment comment) #BooleanRemoves a native Visio comment from the page.
Parameters
- page OfficeIMO.Visio.VisioPage
- comment OfficeIMO.Visio.VisioComment
public static Boolean RemoveComment(VisioPage page, Int32 commentId) #BooleanRemoves a native Visio comment from the page.
Parameters
- page OfficeIMO.Visio.VisioPage
- comment OfficeIMO.Visio.VisioComment
public static Int32 RemoveCommentsForShape(VisioPage page, String shapeId) #Int32Removes all native Visio comments targeting a shape or connector identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- shapeId System.String
public static VisioShape RemoveFromContainer(VisioPage page, VisioShape container, VisioShape member, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #VisioShapeRemoves one member shape from a Visio-native container and optionally resizes the container around remaining members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static VisioShape RemoveFromContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #VisioShapeRemoves one member shape from a Visio-native container and optionally resizes the container around remaining members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static VisioComment ReopenComment(VisioPage page, Int32 commentId, Nullable<DateTimeOffset> editedAt = null) #VisioCommentReopens a native Visio comment by its page-scoped identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- commentId System.Int32
- editedAt System.Nullable{System.DateTimeOffset} = null
public static VisioShape ReplaceMaster(VisioPage page, VisioShape shape, String masterNameU, Boolean resizeToMaster = false) #VisioShapeReplaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the shape.
- shape OfficeIMO.Visio.VisioShape
- Shape to update.
- masterNameU System.String
- Replacement master universal name.
- resizeToMaster System.Boolean = false
- Whether to resize the shape to the replacement master's default size.
Returns
The updated shape.
public static VisioShape ReplaceMaster(VisioPage page, VisioShape shape, VisioMaster master, Boolean resizeToMaster = false) #VisioShapeReplaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the shape.
- shape OfficeIMO.Visio.VisioShape
- Shape to update.
- masterNameU System.String
- Replacement master universal name.
- resizeToMaster System.Boolean = false
- Whether to resize the shape to the replacement master's default size.
Returns
The updated shape.
public static VisioShape ReplaceMaster(VisioPage page, VisioShape shape, VisioStencilShape stencil, Boolean resizeToMaster = false) #VisioShapeReplaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the shape.
- shape OfficeIMO.Visio.VisioShape
- Shape to update.
- masterNameU System.String
- Replacement master universal name.
- resizeToMaster System.Boolean = false
- Whether to resize the shape to the replacement master's default size.
Returns
The updated shape.
public static VisioComment ResolveComment(VisioPage page, Int32 commentId, Nullable<DateTimeOffset> editedAt = null) #VisioCommentMarks a native Visio comment as done by its page-scoped identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- commentId System.Int32
- editedAt System.Nullable{System.DateTimeOffset} = null
public static VisioPage ResolveConnectorLabelOverlaps(VisioPage page, Double step = 0.18, Int32 maxAttempts = 12, Boolean avoidShapes = true, Boolean avoidLabels = true, Boolean preferEndpointZones = false, Boolean avoidConnectorPaths = true, Double positionStep = 0.08, Int32 maxPositionShifts = 4, Int32 optimizationPasses = 1) #VisioPageMoves connector label boxes away from page edges, unrelated shapes, and previously placed connector labels.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page whose connector labels should be adjusted.
- step System.Double = 0.18
- Search step in page units, expressed in inches.
- maxAttempts System.Int32 = 12
- Number of search rings to try around the current label position.
- avoidShapes System.Boolean = true
- Whether labels should avoid unrelated non-container shapes.
- avoidLabels System.Boolean = true
- Whether labels should avoid other connector labels.
- preferEndpointZones System.Boolean = false
- Whether labels should prefer common endpoint zones and avoid unrelated background zones.
- avoidConnectorPaths System.Boolean = true
- Whether labels should avoid unrelated connector paths.
- positionStep System.Double = 0.08
- Connector path-position search step, from 0.0 to 1.0.
- maxPositionShifts System.Int32 = 4
- Number of positive and negative connector path-position shifts to try.
- optimizationPasses System.Int32 = 1
- Number of whole-page label optimization passes to run after the initial placement sweep.
public static IReadOnlyList<VisioComment> ResolvedComments(VisioPage page) #IReadOnlyList<VisioComment>Returns native Visio comments that are marked as done.
Parameters
- page OfficeIMO.Visio.VisioPage
public static VisioPage ResolveShapeOverlaps(VisioPage page, Double step = 0.25, Int32 maxAttempts = 24, Boolean includeContainers = false) #VisioPageMoves overlapping top-level shapes apart using a deterministic nearest-open-position search.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to update.
- step System.Double = 0.25
- Search step in inches.
- maxAttempts System.Int32 = 24
- Number of search rings to try around each overlapping shape.
- includeContainers System.Boolean = false
- Whether container and background surface shapes should be moved and treated as obstacles.
public static VisioPage RouteConnectorsOrthogonalAroundShapes(VisioPage page, Double padding = 0.15, Int32 maxLanes = 12) #VisioPageRoutes every connector on the page around unrelated top-level shapes using deterministic orthogonal lanes.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page whose connectors should be rerouted.
- padding System.Double = 0.15
- Padding added around each obstacle while testing route intersections.
- maxLanes System.Int32 = 12
- Number of positive and negative routing lanes to try on each axis.
public static VisioPage RouteConnectorsOrthogonalAroundShapes(VisioPage page, VisioConnectorRoutingOptions options) #VisioPageRoutes every connector on the page around unrelated top-level shapes using deterministic orthogonal lanes.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page whose connectors should be rerouted.
- options OfficeIMO.Visio.VisioConnectorRoutingOptions
- Routing options controlling padding, lane search, and whether zones/containers count as obstacles.
public static Void SaveAsPng(VisioPage page, String path, VisioPngSaveOptions options = null) #VoidSaves the selected document page as PNG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static Void SaveAsPng(VisioPage page, Stream stream, VisioPngSaveOptions options = null) #VoidSaves the selected document page as PNG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static Void SaveAsSvg(VisioPage page, String path, VisioSvgSaveOptions options = null) #VoidSaves the selected document page as SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static Void SaveAsSvg(VisioPage page, Stream stream, VisioSvgSaveOptions options = null) #VoidSaves the selected document page as SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- path System.String
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static VisioShapeSelection SelectByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes created from a matching master universal name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- masterNameU System.String
- Master universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes with a matching shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes with a matching universal shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- nameU System.String
- Universal shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectCallouts(VisioPage page) #VisioShapeSelectionSelects shapes marked as OfficeIMO callouts or annotations.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectConnectedComponent(VisioPage page, VisioShape shape, Boolean includeStart = true) #VisioShapeSelectionSelects every shape reachable from the provided shape through connectors.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Starting shape.
- includeStart System.Boolean = true
- Whether the starting shape should be included in the returned component.
public static VisioConnectorSelection SelectConnectedConnectors(VisioPage page, VisioShape shape) #VisioConnectorSelectionSelects connectors that either start or end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to or from.
public static VisioConnectorSelection SelectConnectors(VisioPage page, Func<VisioConnector, Boolean> predicate) #VisioConnectorSelectionSelects connectors matching a predicate for bulk editing.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioConnector,System.Boolean}
- Predicate used to include connectors.
public static VisioConnectorSelection SelectConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #VisioConnectorSelectionSelects connectors assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectConnectorsWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #VisioConnectorSelectionSelects connectors that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectConnectorsWithHyperlinks(VisioPage page) #VisioConnectorSelectionSelects connectors that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page) #VisioConnectorSelectionSelects connectors that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page, Func<VisioProtection, Boolean> predicate) #VisioConnectorSelectionSelects connectors whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean}
- Protection predicate.
public static VisioShapeSelection SelectContainedIn(VisioPage page, VisioShapeBounds bounds) #VisioShapeSelectionSelects shapes whose bounds are fully contained by the provided bounds.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- bounds OfficeIMO.Visio.VisioShapeBounds
- Containing bounds.
public static VisioShapeSelection SelectContainedIn(VisioPage page, VisioShape container, Boolean includeContainer = false) #VisioShapeSelectionSelects shapes whose bounds are fully contained by the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- container OfficeIMO.Visio.VisioShape
- Shape whose bounds are used as the containing area.
- includeContainer System.Boolean = false
- Whether the containing shape itself should be included.
public static VisioShapeSelection SelectContainers(VisioPage page) #VisioShapeSelectionSelects shapes marked as Visio-native containers.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes whose text contains the provided value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- text System.String
- Text fragment to find.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectIncomingConnectors(VisioPage page, VisioShape shape) #VisioConnectorSelectionSelects connectors that end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to.
public static VisioShapeSelection SelectIntersecting(VisioPage page, VisioShapeBounds bounds) #VisioShapeSelectionSelects shapes whose bounds intersect the provided bounds.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- bounds OfficeIMO.Visio.VisioShapeBounds
- Bounds to test against.
public static VisioShapeSelection SelectIntersecting(VisioPage page, VisioShape shape, Boolean includeSelf = false) #VisioShapeSelectionSelects shapes whose bounds intersect the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape whose bounds are used for the test.
- includeSelf System.Boolean = false
- Whether the reference shape itself should be included.
public static VisioShapeSelection SelectLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectOutgoingConnectors(VisioPage page, VisioShape shape) #VisioConnectorSelectionSelects connectors that start at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected from.
public static VisioShapeSelection SelectPathBetween(VisioPage page, VisioShape from, VisioShape to, Boolean includeEndpoints = true) #VisioShapeSelectionSelects the shortest shape path between two connected shapes.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- from OfficeIMO.Visio.VisioShape
- Starting shape.
- to OfficeIMO.Visio.VisioShape
- Target shape.
- includeEndpoints System.Boolean = true
- Whether the starting and target shapes should be included.
public static VisioShapeSelection SelectShapes(VisioPage page, Func<VisioShape, Boolean> predicate) #VisioShapeSelectionSelects shapes matching a predicate for bulk editing.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShape,System.Boolean}
- Predicate used to include shapes.
public static VisioShapeSelection SelectWithData(VisioPage page, String key) #VisioShapeSelectionSelects shapes that contain the provided data key.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
public static VisioShapeSelection SelectWithData(VisioPage page, String key, String value, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes that contain the provided data key and value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
- value System.String
- Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectWithData(VisioPage page, String key, Func<String, Boolean> predicate) #VisioShapeSelectionSelects shapes whose Shape Data value for the provided key matches a predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
- predicate System.Func{System.String,System.Boolean}
- Predicate that receives the current Shape Data value.
public static VisioShapeSelection SelectWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectWithHyperlinks(VisioPage page) #VisioShapeSelectionSelects shapes that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectWithProtection(VisioPage page) #VisioShapeSelectionSelects shapes that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectWithProtection(VisioPage page, Func<VisioShapeProtection, Boolean> predicate) #VisioShapeSelectionSelects shapes whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean}
- Protection predicate.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name) #VisioShapeSelectionSelects shapes that contain a Visio Shape Data row.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes with a matching Visio Shape Data value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
- value System.String
- Shape Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name, Func<String, Boolean> predicate) #VisioShapeSelectionSelects shapes whose Visio Shape Data value for the provided row name matches a predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
- predicate System.Func{System.String,System.Boolean}
- Predicate that receives the current Shape Data value.
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name) #VisioShapeSelectionSelects shapes that contain a Visio User cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #VisioShapeSelectionSelects shapes with a matching Visio User cell value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
- value System.String
- User cell value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes created from a matching master universal name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- masterNameU System.String
- Master universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes with a matching shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes with a matching universal shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- nameU System.String
- Universal shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesContainedIn(VisioPage page, VisioShapeBounds bounds) #IReadOnlyList<VisioShape>Returns shapes whose bounds are fully contained by the provided bounds.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- bounds OfficeIMO.Visio.VisioShapeBounds
- Containing bounds.
public static IReadOnlyList<VisioShape> ShapesContainedIn(VisioPage page, VisioShape container, Boolean includeContainer = false) #IReadOnlyList<VisioShape>Returns shapes whose bounds are fully contained by the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- container OfficeIMO.Visio.VisioShape
- Shape whose bounds are used as the containing area.
- includeContainer System.Boolean = false
- Whether the containing shape itself should be included.
public static IReadOnlyList<VisioShape> ShapesContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes whose text contains the provided value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- text System.String
- Text fragment to find.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesIntersecting(VisioPage page, VisioShapeBounds bounds) #IReadOnlyList<VisioShape>Returns shapes whose bounds intersect the provided bounds.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- bounds OfficeIMO.Visio.VisioShapeBounds
- Bounds to test against.
public static IReadOnlyList<VisioShape> ShapesIntersecting(VisioPage page, VisioShape shape, Boolean includeSelf = false) #IReadOnlyList<VisioShape>Returns shapes whose bounds intersect the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape whose bounds are used for the test.
- includeSelf System.Boolean = false
- Whether the reference shape itself should be included.
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key) #IReadOnlyList<VisioShape>Returns shapes that contain the provided data key.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key, String value, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes that contain the provided data key and value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
- value System.String
- Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key, Func<String, Boolean> predicate) #IReadOnlyList<VisioShape>Returns shapes whose Shape Data value for the provided key matches a predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
- predicate System.Func{System.String,System.Boolean}
- Predicate that receives the current Shape Data value.
public static IReadOnlyList<VisioShape> ShapesWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithHyperlinks(VisioPage page) #IReadOnlyList<VisioShape>Returns shapes that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static IReadOnlyList<VisioShape> ShapesWithProtection(VisioPage page) #IReadOnlyList<VisioShape>Returns shapes that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static IReadOnlyList<VisioShape> ShapesWithProtection(VisioPage page, Func<VisioShapeProtection, Boolean> predicate) #IReadOnlyList<VisioShape>Returns shapes whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean}
- Protection predicate.
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name) #IReadOnlyList<VisioShape>Returns shapes that contain a Visio Shape Data row.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes with a matching Visio Shape Data value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
- value System.String
- Shape Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name, Func<String, Boolean> predicate) #IReadOnlyList<VisioShape>Returns shapes whose Visio Shape Data value for the provided row name matches a predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
- predicate System.Func{System.String,System.Boolean}
- Predicate that receives the current Shape Data value.
public static IReadOnlyList<VisioShape> ShapesWithUserCell(VisioPage page, String name) #IReadOnlyList<VisioShape>Returns shapes that contain a Visio User cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
public static IReadOnlyList<VisioShape> ShapesWithUserCell(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #IReadOnlyList<VisioShape>Returns shapes with a matching Visio User cell value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
- value System.String
- User cell value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static Byte[] ToPng(VisioPage page, VisioPngSaveOptions options = null) #Byte[]Renders the selected document page to PNG bytes without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioPngSaveOptions = null
public static String ToSvg(VisioPage page, VisioSvgSaveOptions options = null) #StringRenders the selected document page to SVG without requiring Microsoft Visio desktop automation.
Parameters
- document OfficeIMO.Visio.VisioDocument
- options OfficeIMO.Visio.VisioSvgSaveOptions = null
public static IReadOnlyList<VisioComment> UnresolvedComments(VisioPage page) #IReadOnlyList<VisioComment>Returns native Visio comments that are not marked as done.
Parameters
- page OfficeIMO.Visio.VisioPage
public static VisioComment UpdateCommentText(VisioPage page, Int32 commentId, String text, Nullable<DateTimeOffset> editedAt = null) #VisioCommentUpdates a native Visio comment's text by its page-scoped identifier.
Parameters
- page OfficeIMO.Visio.VisioPage
- commentId System.Int32
- text System.String
- editedAt System.Nullable{System.DateTimeOffset} = null