API Reference
Class
VisioLayoutExtensions
Layout and geometry helpers for Visio pages, shapes, and selections.
Inheritance
- Object
- VisioLayoutExtensions
Methods
Align 2 overloads
public static VisioShapeSelection Align(VisioShapeSelection selection, VisioHorizontalAlignment alignment) #Returns:
VisioShapeSelectionAligns selected shapes horizontally inside the current selection bounds.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to align.
- alignment OfficeIMO.Visio.VisioHorizontalAlignment
- Horizontal alignment.
public static VisioShapeSelection Align(VisioShapeSelection selection, VisioVerticalAlignment alignment) #Returns:
VisioShapeSelectionAligns selected shapes vertically inside the current selection bounds.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to align.
- alignment OfficeIMO.Visio.VisioVerticalAlignment
- Vertical alignment.
public static VisioPage CenterContent(VisioPage page) #Returns:
VisioPageCenters top-level page shapes within the current page size.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to update.
public static VisioShapeSelection Distribute(VisioShapeSelection selection, VisioDistributionAxis axis) #Returns:
VisioShapeSelectionDistributes selected shapes by center point along the requested axis.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to distribute.
- axis OfficeIMO.Visio.VisioDistributionAxis
- Distribution axis.
public static VisioShapeSelection DistributeHorizontally(VisioShapeSelection selection) #Returns:
VisioShapeSelectionDistributes selected shapes horizontally by center point.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to distribute.
public static VisioShapeSelection DistributeVertically(VisioShapeSelection selection) #Returns:
VisioShapeSelectionDistributes selected shapes vertically by center point.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to distribute.
FitToContent 3 overloads
public static VisioPage FitToContent(VisioPage page, Double margin = 0.5, Boolean resizePage = true) #Returns:
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, VisioFitToContentOptions options) #Returns:
VisioPageFits an imported page using explicit group-child, connector-route, translation, and resize policies. Rotation-aware shape bounds and connector label boxes are used.
Parameters
- page OfficeIMO.Visio.VisioPage
- options OfficeIMO.Visio.VisioFitToContentOptions
public static VisioPage FitToContent(VisioPage page, Double horizontalMargin, Double verticalMargin, Boolean resizePage = true) #Returns:
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 VisioShapeBounds GetContentBounds(VisioPage page, Boolean includeGroupChildren = false, Boolean includeConnectors = true) #Returns:
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 VisioShapeBounds GetPageShapeBounds(VisioShape shape) #Returns:
VisioShapeBoundsGets rotation-aware bounds in page coordinates, including every parent-group transform for a nested shape.
Parameters
- shape OfficeIMO.Visio.VisioShape
GetShapeBounds 3 overloads
public static VisioShapeBounds GetShapeBounds(VisioShape shape) #Returns:
VisioShapeBoundsGets the page-space bounds for a shape.
Parameters
- shape OfficeIMO.Visio.VisioShape
- Shape to inspect.
public static VisioShapeBounds GetShapeBounds(IEnumerable<VisioShape> shapes) #Returns:
VisioShapeBoundsGets aggregate bounds for a shape sequence.
Parameters
- shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- Shapes to inspect.
public static VisioShapeBounds GetShapeBounds(VisioShapeSelection selection) #Returns:
VisioShapeBoundsGets the bounds of a shape selection.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to inspect.
RelayoutAsGrid 2 overloads
public static VisioShapeSelection RelayoutAsGrid(VisioShapeSelection selection, Int32 columns = 0, Double horizontalSpacing = 0.5, Double verticalSpacing = 0.5, Boolean routeInternalConnectors = true) #Returns:
VisioShapeSelectionRelays out selected shapes into a deterministic grid and optionally reroutes internal connectors.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to relayout.
- columns System.Int32 = 0
- Number of columns. When zero, OfficeIMO uses a near-square grid.
- horizontalSpacing System.Double = 0.5
- Horizontal spacing between columns in inches.
- verticalSpacing System.Double = 0.5
- Vertical spacing between rows in inches.
- routeInternalConnectors System.Boolean = true
- Whether connectors whose endpoints are both selected should be rerouted orthogonally.
public static VisioShapeSelection RelayoutAsGrid(VisioShapeSelection selection, VisioSelectionLayoutOptions options) #Returns:
VisioShapeSelectionRelays out selected shapes into a deterministic grid and optionally reroutes internal connectors.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to relayout.
- options OfficeIMO.Visio.VisioSelectionLayoutOptions
- Layout options.
public static VisioShapeSelection RelayoutAsHorizontalStack(VisioShapeSelection selection, Double spacing = 0.5, Boolean routeInternalConnectors = true) #Returns:
VisioShapeSelectionRelays out selected shapes as a horizontal row and optionally reroutes internal connectors.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to relayout.
- spacing System.Double = 0.5
- Horizontal spacing between shapes in inches.
- routeInternalConnectors System.Boolean = true
- Whether connectors whose endpoints are both selected should be rerouted orthogonally.
public static VisioShapeSelection RelayoutAsVerticalStack(VisioShapeSelection selection, Double spacing = 0.5, Boolean routeInternalConnectors = true) #Returns:
VisioShapeSelectionRelays out selected shapes as a vertical stack and optionally reroutes internal connectors.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to relayout.
- spacing System.Double = 0.5
- Vertical spacing between shapes in inches.
- routeInternalConnectors System.Boolean = true
- Whether connectors whose endpoints are both selected should be rerouted orthogonally.
public static VisioConnectorSelection ResizeLabelsToText(VisioConnectorSelection selection, Nullable<OfficeFontInfo> fontInfo = null, Double horizontalPadding = 0.12, Double verticalPadding = 0.06, Double minimumWidth = 0.45, Double minimumHeight = 0.22, Nullable<Double> maximumWidth = null) #Returns:
VisioConnectorSelectionResizes selected connector label text boxes to fit their plain text using deterministic OfficeIMO.Drawing measurement.
Parameters
- selection OfficeIMO.Visio.VisioConnectorSelection
- Connector selection.
- fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null
- Font descriptor used for measurement. Uses connector text style, then Office default, when omitted.
- horizontalPadding System.Double = 0.12
- Horizontal padding in inches.
- verticalPadding System.Double = 0.06
- Vertical padding in inches.
- minimumWidth System.Double = 0.45
- Minimum resulting label width in inches.
- minimumHeight System.Double = 0.22
- Minimum resulting label height in inches.
- maximumWidth System.Nullable{System.Double} = null
- Optional maximum label width in inches. Text wraps by words when supplied.
public static VisioConnector ResizeLabelToText(VisioConnector connector, Nullable<OfficeFontInfo> fontInfo = null, Double horizontalPadding = 0.12, Double verticalPadding = 0.06, Double minimumWidth = 0.45, Double minimumHeight = 0.22, Nullable<Double> maximumWidth = null) #Returns:
VisioConnectorResizes a connector label text box to fit its plain text using deterministic OfficeIMO.Drawing measurement.
Parameters
- connector OfficeIMO.Visio.VisioConnector
- Connector whose label box should be resized.
- fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null
- Font descriptor used for measurement. Uses connector text style, then Office default, when omitted.
- horizontalPadding System.Double = 0.12
- Horizontal padding in inches.
- verticalPadding System.Double = 0.06
- Vertical padding in inches.
- minimumWidth System.Double = 0.45
- Minimum resulting label width in inches.
- minimumHeight System.Double = 0.22
- Minimum resulting label height in inches.
- maximumWidth System.Nullable{System.Double} = null
- Optional maximum label width in inches. Text wraps by words when supplied.
ResizeToText 2 overloads
public static VisioShape ResizeToText(VisioShape shape, Nullable<OfficeFontInfo> fontInfo = null, Double horizontalPadding = 0.25, Double verticalPadding = 0.14, Double minimumWidth = 0.5, Double minimumHeight = 0.3) #Returns:
VisioShapeResizes a shape to fit its plain text using deterministic OfficeIMO.Drawing measurement.
Parameters
- shape OfficeIMO.Visio.VisioShape
- Shape to resize.
- fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null
- Font descriptor used for measurement. Uses Office default when omitted.
- horizontalPadding System.Double = 0.25
- Horizontal padding in inches.
- verticalPadding System.Double = 0.14
- Vertical padding in inches.
- minimumWidth System.Double = 0.5
- Minimum resulting width in inches.
- minimumHeight System.Double = 0.3
- Minimum resulting height in inches.
public static VisioShapeSelection ResizeToText(VisioShapeSelection selection, Nullable<OfficeFontInfo> fontInfo = null, Double horizontalPadding = 0.25, Double verticalPadding = 0.14, Double minimumWidth = 0.5, Double minimumHeight = 0.3) #Returns:
VisioShapeSelectionResizes selected shapes to fit their plain text using deterministic OfficeIMO.Drawing measurement.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- Selection to resize.
- fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null
- Font descriptor used for measurement. Uses Office default when omitted.
- horizontalPadding System.Double = 0.25
- Horizontal padding in inches.
- verticalPadding System.Double = 0.14
- Vertical padding in inches.
- minimumWidth System.Double = 0.5
- Minimum resulting width in inches.
- minimumHeight System.Double = 0.3
- Minimum resulting height in inches.
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) #Returns:
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 VisioPage ResolveShapeOverlaps(VisioPage page, Double step = 0.25, Int32 maxAttempts = 24, Boolean includeContainers = false) #Returns:
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.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object