API Reference

Class

VisioPage

Namespace OfficeIMO.Visio
Assembly OfficeIMO.Visio

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

Accepted by parameters

Constructors

VisioPage 2 overloads
public VisioPage(String name) #

Initializes a new instance of the VisioPage class with default A4 size.

Parameters

name System.String requiredposition: 0
Name of the page.
public VisioPage(String name, Double widthInches, Double heightInches) #

Initializes a new instance of the VisioPage class.

Parameters

name System.String requiredposition: 0
Name of the page.
widthInches System.Double requiredposition: 1
Page width in inches.
heightInches System.Double requiredposition: 2
Page height in inches.

Methods

AddCircle 2 overloads
public VisioShape AddCircle(Double x, Double y, Double diameter, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a circle shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
diameter System.Double requiredposition: 2
Diameter of the circle.
text System.String = null optionalposition: 3
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 4
Measurement unit.

Returns

The created circle shape.

public VisioShape AddCircle(Double x, Double y, Double diameter, String text = null) #
Returns: VisioShape

Adds a circle using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
diameter System.Double requiredposition: 2
Diameter of the circle.
text System.String = null optionalposition: 3
Optional text.

Returns

The created circle shape.

AddConnector 2 overloads
public VisioConnector AddConnector(String id, VisioShape from, VisioShape to, ConnectorKind kind, VisioSide fromSide = Auto, VisioSide toSide = Auto) #
Returns: VisioConnector

Adds a connector between two shapes.

Parameters

id System.String requiredposition: 0
Identifier of the connector.
from OfficeIMO.Visio.VisioShape requiredposition: 1
Shape from which the connector starts.
to OfficeIMO.Visio.VisioShape requiredposition: 2
Shape to which the connector ends.
kind OfficeIMO.Visio.ConnectorKind requiredposition: 3
Type of connector.
fromSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 4
Preferred side on the source shape.
toSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 5
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) #
Returns: VisioConnector

Adds a connector between two shapes, optionally specifying side connection points.

Parameters

from OfficeIMO.Visio.VisioShape requiredposition: 0
Source shape.
to OfficeIMO.Visio.VisioShape requiredposition: 1
Target shape.
kind OfficeIMO.Visio.ConnectorKind = Dynamic optionalposition: 2
Connector kind (straight, curved, etc.).
fromSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 3
Preferred side on the source shape.
toSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 4
Preferred side on the target shape.

Returns

The created connector.

AddContainer 2 overloads
public VisioShape AddContainer(String id, String text, IEnumerable<VisioShape> members, VisioContainerOptions options = null) #
Returns: VisioShape

Adds a Visio-native container shape around existing member shapes.

Parameters

id System.String requiredposition: 0
Container shape identifier.
text System.String requiredposition: 1
Container heading text.
members System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape} requiredposition: 2
Shapes that should belong to the container.
options OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 3
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) #
Returns: VisioShape

Adds a Visio-native container shape at an explicit location and size.

Parameters

id System.String requiredposition: 0
Container shape identifier.
pinX System.Double requiredposition: 1
Container pin X coordinate.
pinY System.Double requiredposition: 2
Container pin Y coordinate.
width System.Double requiredposition: 3
Container width.
height System.Double requiredposition: 4
Container height.
text System.String = null optionalposition: 5
Container heading text.
options OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 6
Optional style and semantic settings.

Returns

The created container shape.

AddData 2 overloads
public VisioShape AddData(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart data shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the data shape.
height System.Double requiredposition: 3
Height of the data shape.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created data shape.

public VisioShape AddData(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart data shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddDecision 2 overloads
public VisioShape AddDecision(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart decision shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the decision shape.
height System.Double requiredposition: 3
Height of the decision shape.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created decision shape.

public VisioShape AddDecision(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart decision shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddDiamond 2 overloads
public VisioShape AddDiamond(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a diamond shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the diamond.
height System.Double requiredposition: 3
Height of the diamond.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created diamond shape.

public VisioShape AddDiamond(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a diamond using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the diamond.
height System.Double requiredposition: 3
Height of the diamond.
text System.String = null optionalposition: 4
Optional text.

Returns

The created diamond shape.

AddEllipse 2 overloads
public VisioShape AddEllipse(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds an ellipse shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the ellipse.
height System.Double requiredposition: 3
Height of the ellipse.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created ellipse shape.

public VisioShape AddEllipse(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds an ellipse using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the ellipse.
height System.Double requiredposition: 3
Height of the ellipse.
text System.String = null optionalposition: 4
Optional text.

Returns

The created ellipse shape.

AddHexagon 2 overloads
public VisioShape AddHexagon(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a hexagon shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the hexagon.
height System.Double requiredposition: 3
Height of the hexagon.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created hexagon shape.

public VisioShape AddHexagon(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a hexagon shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
public VisioLayer AddLayer(String name, String nameU = null) #
Returns: VisioLayer

Adds a page layer, or returns the existing layer with the same name or universal name.

Parameters

name System.String requiredposition: 0
Layer display name.
nameU System.String = null optionalposition: 1
Optional universal name.
AddManualOperation 2 overloads
public VisioShape AddManualOperation(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart manual operation shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the manual operation shape.
height System.Double requiredposition: 3
Height of the manual operation shape.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created manual operation shape.

public VisioShape AddManualOperation(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart manual operation shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddOffPageReference 2 overloads
public VisioShape AddOffPageReference(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart off-page reference shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the off-page reference shape.
height System.Double requiredposition: 3
Height of the off-page reference shape.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created off-page reference shape.

public VisioShape AddOffPageReference(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart off-page reference shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddParallelogram 2 overloads
public VisioShape AddParallelogram(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a parallelogram shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the parallelogram.
height System.Double requiredposition: 3
Height of the parallelogram.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created parallelogram shape.

public VisioShape AddParallelogram(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a parallelogram shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddPentagon 2 overloads
public VisioShape AddPentagon(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a pentagon shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the pentagon.
height System.Double requiredposition: 3
Height of the pentagon.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created pentagon shape.

public VisioShape AddPentagon(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a pentagon shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddPreparation 2 overloads
public VisioShape AddPreparation(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart preparation shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the preparation shape.
height System.Double requiredposition: 3
Height of the preparation shape.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created preparation shape.

public VisioShape AddPreparation(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart preparation shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddProcess 2 overloads
public VisioShape AddProcess(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a flowchart process shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the process box.
height System.Double requiredposition: 3
Height of the process box.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created process shape.

public VisioShape AddProcess(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a flowchart process shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddRectangle 2 overloads
public VisioShape AddRectangle(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a rectangle shape.

Parameters

x System.Double requiredposition: 0
X coordinate of the shape origin.
y System.Double requiredposition: 1
Y coordinate of the shape origin.
width System.Double requiredposition: 2
Width of the rectangle.
height System.Double requiredposition: 3
Height of the rectangle.
text System.String = null optionalposition: 4
Optional text placed on the shape.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
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) #
Returns: VisioShape

Adds a rectangle shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the rectangle.
height System.Double requiredposition: 3
Height of the rectangle.
text System.String = null optionalposition: 4
Optional text.

Returns

The created rectangle shape.

AddShape 3 overloads
public VisioShape AddShape(String id, String masterNameU, Double x, Double y, Double w, Double h, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a shape to the page.

Parameters

id System.String requiredposition: 0
Identifier of the shape.
master OfficeIMO.Visio.VisioMaster requiredposition: 1
Master associated with the shape.
x System.Double requiredposition: 2
X coordinate.
y System.Double requiredposition: 3
Y coordinate.
w System.Double requiredposition: 4
Width of the shape.
h System.Double requiredposition: 5
Height of the shape.
text System.String = null optionalposition: 6
Optional text.
unit System.Nullable{OfficeIMO.Visio.VisioMeasurementUnit} = Inches optionalposition: 7
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 required
Identifier of the shape.
masterNameU System.String required
Registered master universal name.
x System.Double required
X coordinate.
y System.Double required
Y coordinate.
w System.Double required
Width.
h System.Double required
Height.
text System.String required
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit required
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) #
Returns: VisioShape

Adds a shape using the page DefaultUnit and a document-registered master.

Parameters

id System.String requiredposition: 0
masterNameU System.String requiredposition: 1
x System.Double requiredposition: 2
y System.Double requiredposition: 3
w System.Double requiredposition: 4
h System.Double requiredposition: 5
text System.String = null optionalposition: 6
AddSquare 2 overloads
public VisioShape AddSquare(Double x, Double y, Double size, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a square shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
size System.Double requiredposition: 2
Width and height of the square.
text System.String = null optionalposition: 3
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 4
Measurement unit.

Returns

The created square shape.

public VisioShape AddSquare(Double x, Double y, Double size, String text = null) #
Returns: VisioShape

Adds a square using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
size System.Double requiredposition: 2
Width and height of the square.
text System.String = null optionalposition: 3
Optional text.

Returns

The created square shape.

AddTextBox 4 overloads
public VisioShape AddTextBox(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds an editable text box without a visible border or fill.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the text box.
height System.Double requiredposition: 3
Height of the text box.
text System.String = null optionalposition: 4
Text to place in the box.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
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) #
Returns: VisioShape

Adds an editable text box with a caller-provided shape id and without a visible border or fill.

Parameters

id System.String requiredposition: 0
Shape identifier.
x System.Double requiredposition: 1
X coordinate.
y System.Double requiredposition: 2
Y coordinate.
width System.Double requiredposition: 3
Width of the text box.
height System.Double requiredposition: 4
Height of the text box.
text System.String = null optionalposition: 5
Text to place in the box.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 6
Measurement unit.

Returns

The created text box shape.

public VisioShape AddTextBox(String id, Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds 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 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
text System.String = null optionalposition: 5
public VisioShape AddTextBox(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds an editable text box without a visible border or fill using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddToLayer 2 overloads
public VisioPage AddToLayer(String layerName, VisioConnector connector) #
Returns: VisioPage

Adds a shape to a page layer, creating the layer if needed.

Parameters

layerName System.String requiredposition: 0
Layer name.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
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 required
Layer name.
connector OfficeIMO.Visio.VisioConnector required
Connector to assign.
AddTrapezoid 2 overloads
public VisioShape AddTrapezoid(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a trapezoid shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the trapezoid.
height System.Double requiredposition: 3
Height of the trapezoid.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created trapezoid shape.

public VisioShape AddTrapezoid(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a trapezoid shape using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
text System.String = null optionalposition: 4
AddTriangle 2 overloads
public VisioShape AddTriangle(Double x, Double y, Double width, Double height, String text = null, VisioMeasurementUnit unit = Inches) #
Returns: VisioShape

Adds a triangle shape.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the triangle's bounding box.
height System.Double requiredposition: 3
Height of the triangle's bounding box.
text System.String = null optionalposition: 4
Optional text.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 5
Measurement unit.

Returns

The created triangle shape.

public VisioShape AddTriangle(Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a triangle using the page DefaultUnit.

Parameters

x System.Double requiredposition: 0
X coordinate.
y System.Double requiredposition: 1
Y coordinate.
width System.Double requiredposition: 2
Width of the triangle's bounding box.
height System.Double requiredposition: 3
Height of the triangle's bounding box.
text System.String = null optionalposition: 4
Optional text.

Returns

The created triangle shape.

public VisioPage ClearBackgroundPage() #
Returns: VisioPage

Removes the applied background page reference.

public VisioPage ClearConnectorRoutingPolicy() #
Returns: VisioPage

Clears page-level connector routing and line-jump policy cells so Visio can use template defaults.

public VisioPage ClearConnectorSpacing() #
Returns: VisioPage

Clears page-level connector spacing cells so Visio can use template defaults.

public VisioPage ClearLayoutGridPolicy() #
Returns: VisioPage

Clears Visio layout grid enablement and sizing cells so Visio can use template defaults.

public VisioPage ClearLayoutGridSizing() #
Returns: VisioPage

Clears Visio layout grid sizing cells so Visio can use template defaults.

public VisioPage ClearPlacementPolicy() #
Returns: VisioPage

Clears page-level placement policy cells so Visio can use template defaults.

public VisioLayer FindLayer(String nameOrNameU) #
Returns: VisioLayer

Finds a layer by display name or universal name.

Parameters

nameOrNameU System.String requiredposition: 0
Layer name to find.
public VisioPage Grid(Boolean visible, Boolean snap) #
Returns: VisioPage

Configures grid visibility and snapping.

Parameters

visible System.Boolean requiredposition: 0
Whether the grid is visible.
snap System.Boolean requiredposition: 1
Whether snapping is enabled.

Returns

The current page.

public Void ReconnectConnector(VisioConnector connector, VisioShape newFrom, VisioShape newTo, VisioSide fromSide = Auto, VisioSide toSide = Auto) #
Returns: Void

Reconnects both ends of an existing connector.

Parameters

connector OfficeIMO.Visio.VisioConnector requiredposition: 0
newFrom OfficeIMO.Visio.VisioShape requiredposition: 1
newTo OfficeIMO.Visio.VisioShape requiredposition: 2
fromSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 3
toSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 4
public Void ReconnectConnectorEnd(VisioConnector connector, VisioShape newTo, VisioSide side = Auto) #
Returns: Void

Reconnects the end of an existing connector to a different shape.

Parameters

connector OfficeIMO.Visio.VisioConnector requiredposition: 0
newTo OfficeIMO.Visio.VisioShape requiredposition: 1
side OfficeIMO.Visio.VisioSide = Auto optionalposition: 2
public Void ReconnectConnectorStart(VisioConnector connector, VisioShape newFrom, VisioSide side = Auto) #
Returns: Void

Reconnects the start of an existing connector to a different shape.

Parameters

connector OfficeIMO.Visio.VisioConnector requiredposition: 0
newFrom OfficeIMO.Visio.VisioShape requiredposition: 1
side OfficeIMO.Visio.VisioSide = Auto optionalposition: 2
public Void ReparentShape(VisioShape shape, VisioShape newParent, Int32 childIndex = -1) #
Returns: Void

Moves a shape from its current location in the page hierarchy into the provided group shape.

Parameters

shape OfficeIMO.Visio.VisioShape requiredposition: 0
The shape to move.
newParent OfficeIMO.Visio.VisioShape requiredposition: 1
The group that should own the shape after the move.
childIndex System.Int32 = -1 optionalposition: 2
Optional insertion index within the target group's children. Use -1 to append.
public Void ResetDrawingScale() #
Returns: Void

Removes any custom drawing scale override and reverts to ScaleMeasurementUnit.

public Void ResetPageScale() #
Returns: Void

Removes 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) #
Returns: IReadOnlyList<VisioConnector>

Retargets all connector endpoints on this page that currently reference one shape to another.

Parameters

oldShape OfficeIMO.Visio.VisioShape requiredposition: 0
The existing shape referenced by matching connectors.
newShape OfficeIMO.Visio.VisioShape requiredposition: 1
The replacement shape that matching connectors should reference.
endpointScope OfficeIMO.Visio.VisioConnectorEndpointScope = Both optionalposition: 2
Controls whether start points, end points, or both are updated.
fromSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 3
The side to glue to when a start point is updated.
toSide OfficeIMO.Visio.VisioSide = Auto optionalposition: 4
The side to glue to when an end point is updated.

Returns

The connectors that were updated.

public VisioPage SetBackgroundPage(VisioPage backgroundPage) #
Returns: VisioPage

Applies a reusable Visio background page to this page.

Parameters

backgroundPage OfficeIMO.Visio.VisioPage requiredposition: 0
Background page to apply.
SetConnectorSpacing 2 overloads
public VisioPage SetConnectorSpacing(Double lineToLine, Double lineToNode, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets page-level connector and connector-to-shape spacing used by Visio routing.

Parameters

lineToLine System.Double requiredposition: 0
Horizontal and vertical connector-to-connector clearance.
lineToNode System.Double requiredposition: 1
Horizontal and vertical connector-to-shape clearance.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 2
Measurement unit for the provided values.
public VisioPage SetConnectorSpacing(Double lineToLineX, Double lineToLineY, Double lineToNodeX, Double lineToNodeY, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets individual page-level connector routing clearances used by Visio.

Parameters

lineToLineX System.Double requiredposition: 0
Horizontal connector-to-connector clearance.
lineToLineY System.Double requiredposition: 1
Vertical connector-to-connector clearance.
lineToNodeX System.Double requiredposition: 2
Horizontal connector-to-shape clearance.
lineToNodeY System.Double requiredposition: 3
Vertical connector-to-shape clearance.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 4
Measurement unit for the provided values.
SetLayoutGridSizing 2 overloads
public VisioPage SetLayoutGridSizing(Double blockSize, Double avenueSize, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets Visio layout grid block sizes and spacing values.

Parameters

blockSize System.Double requiredposition: 0
Horizontal and vertical average shape block size.
avenueSize System.Double requiredposition: 1
Horizontal and vertical spacing between shapes.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 2
Measurement unit for the provided values.
public VisioPage SetLayoutGridSizing(Double blockSizeX, Double blockSizeY, Double avenueSizeX, Double avenueSizeY, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets individual Visio layout grid block sizes and spacing values.

Parameters

blockSizeX System.Double requiredposition: 0
Horizontal average shape block size.
blockSizeY System.Double requiredposition: 1
Vertical average shape block size.
avenueSizeX System.Double requiredposition: 2
Horizontal spacing between shapes.
avenueSizeY System.Double requiredposition: 3
Vertical spacing between shapes.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 4
Measurement unit for the provided values.
SetMargins 3 overloads
public VisioPage SetMargins(Double margin, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets all print margins to the same value.

Parameters

margin System.Double requiredposition: 0
Margin value.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 1
Measurement unit for the provided value.
public VisioPage SetMargins(Double horizontal, Double vertical, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets horizontal and vertical print margins.

Parameters

horizontal System.Double requiredposition: 0
Left and right margin value.
vertical System.Double requiredposition: 1
Top and bottom margin value.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 2
Measurement unit for the provided values.
public VisioPage SetMargins(Double left, Double right, Double top, Double bottom, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets individual print margins.

Parameters

left System.Double requiredposition: 0
Left margin.
right System.Double requiredposition: 1
Right margin.
top System.Double requiredposition: 2
Top margin.
bottom System.Double requiredposition: 3
Bottom margin.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 4
Measurement unit for the provided values.
public VisioPage Size(Double w, Double h, VisioMeasurementUnit unit = Inches) #
Returns: VisioPage

Sets the page size.

Parameters

w System.Double requiredposition: 0
Width of the page.
h System.Double requiredposition: 1
Height of the page.
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 2
Measurement unit.

Returns

The current page.

public IReadOnlyList<VisioShape> UngroupShape(VisioShape group) #
Returns: IReadOnlyList<VisioShape>

Removes a group shape and promotes its children into the group's former position.

Parameters

group OfficeIMO.Visio.VisioShape requiredposition: 0
The group to ungroup.

Returns

The children that were promoted.

Properties

public Int32 Id { get; set; } #

Gets the identifier of the page within the document.

public String Name { get; } #

Gets the page name.

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

AddCallout 4 overloads
public static VisioShape AddCallout(VisioPage page, VisioShape target, String text, Double pinX, Double pinY, VisioCalloutOptions options = null) #
Returns: VisioShape

Adds a callout near a target shape using an automatically assigned shape identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that receives the callout.
target OfficeIMO.Visio.VisioShape requiredposition: 1
Shape being annotated.
text System.String requiredposition: 2
Callout text.
pinX System.Double requiredposition: 3
Callout pin X coordinate.
pinY System.Double requiredposition: 4
Callout pin Y coordinate.
options OfficeIMO.Visio.VisioCalloutOptions = null optionalposition: 5
Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String text, VisioSide placement, Double gap = 0.35, VisioCalloutOptions options = null) #
Returns: VisioShape

Adds a callout near a target shape using an automatically assigned shape identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that receives the callout.
target OfficeIMO.Visio.VisioShape requiredposition: 1
Shape being annotated.
text System.String requiredposition: 2
Callout text.
pinX System.Double requiredposition: 3
Callout pin X coordinate.
pinY System.Double = 0.35 optionalposition: 4
Callout pin Y coordinate.
options OfficeIMO.Visio.VisioCalloutOptions = null optionalposition: 5
Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String id, String text, Double pinX, Double pinY, VisioCalloutOptions options = null) #
Returns: VisioShape

Adds a callout near a target shape using an explicit shape identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that receives the callout.
target OfficeIMO.Visio.VisioShape requiredposition: 1
Shape being annotated.
id System.String requiredposition: 2
Callout shape identifier.
text System.String requiredposition: 3
Callout text.
pinX System.Double requiredposition: 4
Callout pin X coordinate.
pinY System.Double requiredposition: 5
Callout pin Y coordinate.
options OfficeIMO.Visio.VisioCalloutOptions = null optionalposition: 6
Optional callout options.
public static VisioShape AddCallout(VisioPage page, VisioShape target, String id, String text, VisioSide placement, Double gap = 0.35, VisioCalloutOptions options = null) #
Returns: VisioShape

Adds a callout near a target shape using an explicit shape identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that receives the callout.
target OfficeIMO.Visio.VisioShape requiredposition: 1
Shape being annotated.
id System.String requiredposition: 2
Callout shape identifier.
text System.String requiredposition: 3
Callout text.
pinX System.Double requiredposition: 4
Callout pin X coordinate.
pinY System.Double = 0.35 optionalposition: 5
Callout pin Y coordinate.
options OfficeIMO.Visio.VisioCalloutOptions = null optionalposition: 6
Optional callout options.
AddComment 2 overloads
public static VisioComment AddComment(VisioPage page, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
Returns: VisioComment

Adds a page-level native Visio comment.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
text System.String requiredposition: 1
authorName System.String = null optionalposition: 2
authorInitials System.String = null optionalposition: 3
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 4
public static VisioComment AddComment(VisioPage page, VisioShape target, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
Returns: VisioComment

Adds a native Visio comment to a shape on the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
target OfficeIMO.Visio.VisioShape requiredposition: 1
text System.String requiredposition: 2
authorName System.String = null optionalposition: 3
authorInitials System.String = null optionalposition: 4
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 5
public static VisioComment AddCommentToShape(VisioPage page, String shapeId, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
Returns: VisioComment

Adds a native Visio comment to a shape or connector by identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
shapeId System.String requiredposition: 1
text System.String requiredposition: 2
authorName System.String = null optionalposition: 3
authorInitials System.String = null optionalposition: 4
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 5
public static IReadOnlyList<VisioShape> AddDataGraphics(VisioPage page, VisioShape target, VisioDataGraphic dataGraphic) #
Returns: IReadOnlyList<VisioShape>

Adds visible data graphics for one target shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the target shape.
target OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose Shape Data values should be visualized.
dataGraphic OfficeIMO.Visio.VisioDataGraphic requiredposition: 2
Data graphic definition.
public static IReadOnlyList<VisioShape> AddStencilGallery(VisioPage page, VisioStencilCatalog catalog, VisioStencilGalleryOptions options = null) #
Returns: IReadOnlyList<VisioShape>

Adds a contact-sheet gallery for a stencil catalog to the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Target page.
catalog OfficeIMO.Visio.Stencils.VisioStencilCatalog requiredposition: 1
Stencil catalog to render.
options OfficeIMO.Visio.Stencils.VisioStencilGalleryOptions = null optionalposition: 2
Optional gallery layout and visual options.

Returns

The stencil instance shapes placed in the gallery.

AddStencilShape 8 overloads
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, String text = null) #
Returns: VisioShape

Adds a stencil shape using its default size and the page default measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
text System.String = null optionalposition: 5
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, String text, VisioMeasurementUnit unit) #
Returns: VisioShape

Adds a stencil shape using its default size and an explicit measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
text System.String requiredposition: 5
unit OfficeIMO.Visio.VisioMeasurementUnit requiredposition: 6
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a stencil shape using an explicit size and the page default measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
width System.Double requiredposition: 5
height System.Double requiredposition: 6
text System.String = null optionalposition: 7
public static VisioShape AddStencilShape(VisioPage page, VisioStencilShape stencil, String id, Double x, Double y, Double width, Double height, String text, VisioMeasurementUnit unit) #
Returns: VisioShape

Adds a stencil shape using an explicit size and measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
width System.Double requiredposition: 5
height System.Double requiredposition: 6
text System.String requiredposition: 7
unit OfficeIMO.Visio.VisioMeasurementUnit requiredposition: 8
public static VisioShape AddStencilShape(VisioPage page, VisioStencilCatalog catalog, String stencilIdOrName, String id, Double x, Double y, String text = null) #
Returns: VisioShape

Adds a stencil shape using its default size and an explicit measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
text System.String requiredposition: 5
unit OfficeIMO.Visio.VisioMeasurementUnit = null optionalposition: 6
public static VisioShape AddStencilShape(VisioPage page, VisioStencilCatalog catalog, String stencilIdOrName, String id, Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a stencil shape using an explicit size and measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
width System.Double requiredposition: 5
height System.Double requiredposition: 6
text System.String requiredposition: 7
unit OfficeIMO.Visio.VisioMeasurementUnit = null optionalposition: 8
public static VisioShape AddStencilShape(VisioPage page, String stencilIdOrName, String id, Double x, Double y, String text = null) #
Returns: VisioShape

Adds a stencil shape using its default size and the page default measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
text System.String = null optionalposition: 5
public static VisioShape AddStencilShape(VisioPage page, String stencilIdOrName, String id, Double x, Double y, Double width, Double height, String text = null) #
Returns: VisioShape

Adds a stencil shape using an explicit size and the page default measurement unit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
stencil OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 1
id System.String requiredposition: 2
x System.Double requiredposition: 3
y System.Double requiredposition: 4
width System.Double requiredposition: 5
height System.Double requiredposition: 6
text System.String = null optionalposition: 7
AddToContainer 2 overloads
public static VisioShape AddToContainer(VisioPage page, VisioShape container, VisioShape member, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #
Returns: VisioShape

Adds one member shape to a Visio-native container and optionally resizes the container around all current members.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
container OfficeIMO.Visio.VisioShape requiredposition: 1
member OfficeIMO.Visio.VisioShape requiredposition: 2
resizeToFit System.Boolean = true optionalposition: 3
resizeOptions OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 4
public static VisioShape AddToContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #
Returns: VisioShape

Adds one member shape to a Visio-native container and optionally resizes the container around all current members.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
container OfficeIMO.Visio.VisioShape requiredposition: 1
member OfficeIMO.Visio.VisioShape requiredposition: 2
resizeToFit System.Boolean = true optionalposition: 3
resizeOptions OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 4
public static IReadOnlyList<VisioShape> AllShapes(VisioPage page) #
Returns: IReadOnlyList<VisioShape>

Returns all shapes on the page, including shapes nested inside groups.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static IReadOnlyList<VisioDiagramQualityIssue> AnalyzeVisualQuality(VisioPage page, VisioDiagramQualityOptions options = null) #
Returns: IReadOnlyList<VisioDiagramQualityIssue>

Analyzes every page in a document for common visual quality issues.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
Document to analyze.
options OfficeIMO.Visio.VisioDiagramQualityOptions = null optionalposition: 1
Analysis options.
public static VisioShape ApplyContainerOptions(VisioPage page, VisioShape container, VisioContainerOptions options, Boolean refit = false) #
Returns: VisioShape

Applies native container metadata and visual style to an existing Visio-native container.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape to update.
options OfficeIMO.Visio.VisioContainerOptions requiredposition: 2
Container metadata and style options.
refit System.Boolean = false optionalposition: 3
Whether the container should be refit around current members after metadata is applied.
ApplyStencilMigration 2 overloads
public static VisioStencilMigrationResult ApplyStencilMigration(VisioPage page, VisioStencilMigrationMap map) #
Returns: VisioStencilMigrationResult

Applies a stencil migration map to every foreground page in the document.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
map OfficeIMO.Visio.VisioStencilMigrationMap requiredposition: 1
public static VisioStencilMigrationResult ApplyStencilMigration(VisioPage page, VisioStencilMigrationPlan plan, VisioStencilMigrationMap map) #
Returns: VisioStencilMigrationResult

Applies 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 requiredposition: 0
Document to update.
plan OfficeIMO.Visio.VisioStencilMigrationPlan requiredposition: 1
Reviewed migration plan.
map OfficeIMO.Visio.VisioStencilMigrationMap requiredposition: 2
Migration map used to create the plan.
public static IReadOnlyList<VisioShape> Callouts(VisioPage page) #
Returns: IReadOnlyList<VisioShape>

Returns shapes marked as OfficeIMO callouts or annotations.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static VisioPage CenterContent(VisioPage page) #
Returns: VisioPage

Centers top-level page shapes within the current page size.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to update.
CommentsForShape 2 overloads
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, VisioShape target) #
Returns: IReadOnlyList<VisioComment>

Returns comments that target the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
target OfficeIMO.Visio.VisioShape requiredposition: 1
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, String shapeId) #
Returns: IReadOnlyList<VisioComment>

Returns comments that target the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
target OfficeIMO.Visio.VisioShape requiredposition: 1
public static VisioShape ConfigureContainer(VisioPage page, VisioShape container, Action<VisioContainerOptions> configure, Boolean refit = false) #
Returns: VisioShape

Updates native container metadata and visual style using a callback initialized from the current container state.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape to update.
configure System.Action{OfficeIMO.Visio.VisioContainerOptions} requiredposition: 2
Option callback.
refit System.Boolean = false optionalposition: 3
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) #
Returns: IReadOnlyList<VisioShape>

Returns every shape reachable from the provided shape through connectors.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Starting shape.
includeStart System.Boolean = true optionalposition: 2
Whether the starting shape should be included in the returned component.
public static IReadOnlyList<VisioConnector> ConnectedConnectors(VisioPage page, VisioShape shape) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors that either start or end at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected to or from.
public static IReadOnlyList<VisioShape> ConnectedShapes(VisioPage page, VisioShape shape) #
Returns: IReadOnlyList<VisioShape>

Returns shapes connected to the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose neighbors should be returned.
public static IReadOnlyList<VisioConnector> ConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors assigned to a page layer.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
layerName System.String requiredposition: 1
Layer name or universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
ConnectorsWithProtection 2 overloads
public static IReadOnlyList<VisioConnector> ConnectorsWithProtection(VisioPage page) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors that have at least one explicit protection cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static IReadOnlyList<VisioConnector> ConnectorsWithProtection(VisioPage page, Func<VisioProtection, Boolean> predicate) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors whose protection state matches the predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean} requiredposition: 1
Protection predicate.
public static IReadOnlyList<VisioShape> Containers(VisioPage page) #
Returns: IReadOnlyList<VisioShape>

Returns shapes marked as Visio-native containers.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
Duplicate 2 overloads
public static VisioPage Duplicate(VisioPage page, String name = null) #
Returns: VisioPage

Duplicates this page in its owner document.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to duplicate.
name System.String = null optionalposition: 1
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) #
Returns: VisioPage

Duplicates this page in its owner document.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to duplicate.
name System.String = null requiredposition: 1
Optional name for the duplicate. When omitted, a unique copy name is generated.

Returns

The duplicated page.

DuplicateShapes 2 overloads
public static VisioShapeSelection DuplicateShapes(VisioPage page, IEnumerable<VisioShape> shapes, Double offsetX = 0.35, Double offsetY = -0.35, Boolean includeInternalConnectors = true) #
Returns: VisioShapeSelection

Duplicates shapes on the same page and optionally copies connectors whose endpoints are both duplicated.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the shapes.
shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape} requiredposition: 1
Shapes to duplicate. Nested children are copied with their selected ancestor.
offsetX System.Double = 0.35 optionalposition: 2
Horizontal offset for duplicated top-level shapes and page-coordinate routing points.
offsetY System.Double = -0.35 optionalposition: 3
Vertical offset for duplicated top-level shapes and page-coordinate routing points.
includeInternalConnectors System.Boolean = true optionalposition: 4
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) #
Returns: VisioShapeSelection

Duplicates shapes on the same page and optionally copies connectors whose endpoints are both duplicated.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the shapes.
shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape} requiredposition: 1
Shapes to duplicate. Nested children are copied with their selected ancestor.
options OfficeIMO.Visio.VisioShapeDuplicationOptions requiredposition: 2
Optional duplication settings.

Returns

A selection containing the duplicated root shapes.

public static VisioPage EnsureVisualQuality(VisioPage page, VisioDiagramQualityOptions options = null, VisioDiagramQualityIssueSeverity minimumSeverity = Warning) #
Returns: VisioPage

Throws when a document contains visual quality issues at or above the requested severity.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
options OfficeIMO.Visio.VisioDiagramQualityOptions = null optionalposition: 1
minimumSeverity OfficeIMO.Visio.VisioDiagramQualityIssueSeverity = Warning optionalposition: 2
public static VisioComment FindComment(VisioPage page, Int32 commentId) #
Returns: VisioComment

Finds a native Visio comment by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
public static VisioShape FindShapeById(VisioPage page, String id) #
Returns: VisioShape

Finds a shape by identifier, including shapes nested inside groups.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
id System.String requiredposition: 1
Shape identifier.
public static VisioSwimlaneLane FindSwimlaneLane(VisioPage page, String laneId) #
Returns: VisioSwimlaneLane

Finds a swimlane lane by identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
laneId System.String requiredposition: 1
public static VisioSwimlanePhase FindSwimlanePhase(VisioPage page, String phaseId) #
Returns: VisioSwimlanePhase

Finds a swimlane phase by identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
phaseId System.String requiredposition: 1
FitToContent 2 overloads
public static VisioPage FitToContent(VisioPage page, Double margin = 0.5, Boolean resizePage = true) #
Returns: VisioPage

Moves top-level page shapes so content starts at the requested margin and optionally resizes the page to fit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to update.
margin System.Double = 0.5 optionalposition: 1
Margin in inches around content.
resizePage System.Boolean = true optionalposition: 2
Whether to resize the page around the content.
public static VisioPage FitToContent(VisioPage page, Double horizontalMargin, Double verticalMargin, Boolean resizePage = true) #
Returns: VisioPage

Moves top-level page shapes so content starts at the requested margins and optionally resizes the page to fit.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to update.
horizontalMargin System.Double requiredposition: 1
Horizontal margin in inches.
verticalMargin System.Double requiredposition: 2
Vertical margin in inches.
resizePage System.Boolean = true optionalposition: 3
Whether to resize the page around the content.
public static VisioContainerInfo GetContainerInfo(VisioPage page, VisioShape container) #
Returns: VisioContainerInfo

Gets typed metadata and membership information for a Visio-native container.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape.
public static IReadOnlyList<VisioShape> GetContainerMembers(VisioPage page, VisioShape container) #
Returns: IReadOnlyList<VisioShape>

Gets the shapes currently referenced by a Visio-native container.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape.
public static VisioContainerOptions GetContainerOptions(VisioPage page, VisioShape container) #
Returns: VisioContainerOptions

Gets editable options initialized from a Visio-native container's current metadata and visual style.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape.
public static VisioShapeBounds GetContentBounds(VisioPage page, Boolean includeGroupChildren = false, Boolean includeConnectors = true) #
Returns: VisioShapeBounds

Gets bounds of visible page content, including shapes, explicit connector routes, and connector label boxes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to inspect.
includeGroupChildren System.Boolean = false optionalposition: 1
Whether nested group children should be included using their stored coordinates.
includeConnectors System.Boolean = true optionalposition: 2
Whether connector waypoints and label boxes should be included.
public static IReadOnlyList<VisioSwimlaneActivityPlacement> GetSwimlaneActivities(VisioPage page) #
Returns: IReadOnlyList<VisioSwimlaneActivityPlacement>

Finds swimlane activities and their current lane/phase placement.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
public static IReadOnlyList<VisioSwimlaneLane> GetSwimlaneLanes(VisioPage page) #
Returns: 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 requiredposition: 0
public static IReadOnlyList<VisioSwimlanePhase> GetSwimlanePhases(VisioPage page) #
Returns: 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 requiredposition: 0
public static VisioDiagramQualityReport GetVisualQualityReport(VisioPage page, VisioDiagramQualityOptions options = null) #
Returns: VisioDiagramQualityReport

Creates a visual quality report for every page in a document.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
options OfficeIMO.Visio.VisioDiagramQualityOptions = null optionalposition: 1
public static IReadOnlyList<VisioConnector> IncomingConnectors(VisioPage page, VisioShape shape) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors that end at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected to.
public static VisioPage MoveSwimlaneActivity(VisioPage page, String activityId, String laneId, String phaseId, VisioSwimlaneRelayoutOptions options = null) #
Returns: VisioPage

Moves a swimlane activity to a target lane/phase cell and relayouts the affected swimlane activities.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
activityId System.String requiredposition: 1
laneId System.String requiredposition: 2
phaseId System.String requiredposition: 3
options OfficeIMO.Visio.VisioSwimlaneRelayoutOptions = null optionalposition: 4
public static IReadOnlyList<VisioConnector> OutgoingConnectors(VisioPage page, VisioShape shape) #
Returns: IReadOnlyList<VisioConnector>

Returns connectors that start at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected from.
public static IReadOnlyList<VisioShape> PathBetween(VisioPage page, VisioShape from, VisioShape to, Boolean includeEndpoints = true) #
Returns: IReadOnlyList<VisioShape>

Returns the shortest shape path between two connected shapes, or an empty list when no path exists.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
from OfficeIMO.Visio.VisioShape requiredposition: 1
Starting shape.
to OfficeIMO.Visio.VisioShape requiredposition: 2
Target shape.
includeEndpoints System.Boolean = true optionalposition: 3
Whether the starting and target shapes should be included.
public static VisioStencilMigrationPlan PlanStencilMigration(VisioPage page, VisioStencilMigrationMap map) #
Returns: VisioStencilMigrationPlan

Plans a stencil migration map for every foreground page in the document without modifying the document.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
map OfficeIMO.Visio.VisioStencilMigrationMap requiredposition: 1
public static VisioPage PolishDiagram(VisioPage page, VisioDiagramPolishOptions options = null) #
Returns: VisioPage

Applies a deterministic cleanup pass to a page: optional text fitting, connector label fitting, label collision cleanup, and page fitting.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to polish.
options OfficeIMO.Visio.VisioDiagramPolishOptions = null optionalposition: 1
Optional polish settings.
public static VisioShape RefitContainer(VisioPage page, VisioShape container, VisioContainerOptions options = null) #
Returns: VisioShape

Resizes a Visio-native container so it encloses its current typed members.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the container.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Container shape to resize.
options OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 2
Optional margin and heading settings used for the calculated bounds.
public static VisioPage RelayoutSwimlaneActivities(VisioPage page, VisioSwimlaneRelayoutOptions options = null) #
Returns: VisioPage

Re-centers swimlane activities inside their lane/phase cells, stacking multiple activities deterministically.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
options OfficeIMO.Visio.VisioSwimlaneRelayoutOptions = null optionalposition: 1
RemoveComment 2 overloads
public static Boolean RemoveComment(VisioPage page, VisioComment comment) #
Returns: Boolean

Removes a native Visio comment from the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
comment OfficeIMO.Visio.VisioComment requiredposition: 1
public static Boolean RemoveComment(VisioPage page, Int32 commentId) #
Returns: Boolean

Removes a native Visio comment from the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
comment OfficeIMO.Visio.VisioComment requiredposition: 1
public static Int32 RemoveCommentsForShape(VisioPage page, String shapeId) #
Returns: Int32

Removes all native Visio comments targeting a shape or connector identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
shapeId System.String requiredposition: 1
RemoveFromContainer 2 overloads
public static VisioShape RemoveFromContainer(VisioPage page, VisioShape container, VisioShape member, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #
Returns: VisioShape

Removes one member shape from a Visio-native container and optionally resizes the container around remaining members.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
container OfficeIMO.Visio.VisioShape requiredposition: 1
member OfficeIMO.Visio.VisioShape requiredposition: 2
resizeToFit System.Boolean = true optionalposition: 3
resizeOptions OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 4
public static VisioShape RemoveFromContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #
Returns: VisioShape

Removes one member shape from a Visio-native container and optionally resizes the container around remaining members.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
container OfficeIMO.Visio.VisioShape requiredposition: 1
member OfficeIMO.Visio.VisioShape requiredposition: 2
resizeToFit System.Boolean = true optionalposition: 3
resizeOptions OfficeIMO.Visio.VisioContainerOptions = null optionalposition: 4
public static VisioComment ReopenComment(VisioPage page, Int32 commentId, Nullable<DateTimeOffset> editedAt = null) #
Returns: VisioComment

Reopens a native Visio comment by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 2
ReplaceMaster 3 overloads
public static VisioShape ReplaceMaster(VisioPage page, VisioShape shape, String masterNameU, Boolean resizeToMaster = false) #
Returns: VisioShape

Replaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the shape.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape to update.
masterNameU System.String requiredposition: 2
Replacement master universal name.
resizeToMaster System.Boolean = false optionalposition: 3
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) #
Returns: VisioShape

Replaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the shape.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape to update.
masterNameU System.String requiredposition: 2
Replacement master universal name.
resizeToMaster System.Boolean = false optionalposition: 3
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) #
Returns: VisioShape

Replaces a shape's master by universal master name while preserving its position, text, style, data, and connectors.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page that owns the shape.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape to update.
masterNameU System.String requiredposition: 2
Replacement master universal name.
resizeToMaster System.Boolean = false optionalposition: 3
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) #
Returns: VisioComment

Marks a native Visio comment as done by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 2
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: VisioPage

Moves connector label boxes away from page edges, unrelated shapes, and previously placed connector labels.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page whose connector labels should be adjusted.
step System.Double = 0.18 optionalposition: 1
Search step in page units, expressed in inches.
maxAttempts System.Int32 = 12 optionalposition: 2
Number of search rings to try around the current label position.
avoidShapes System.Boolean = true optionalposition: 3
Whether labels should avoid unrelated non-container shapes.
avoidLabels System.Boolean = true optionalposition: 4
Whether labels should avoid other connector labels.
preferEndpointZones System.Boolean = false optionalposition: 5
Whether labels should prefer common endpoint zones and avoid unrelated background zones.
avoidConnectorPaths System.Boolean = true optionalposition: 6
Whether labels should avoid unrelated connector paths.
positionStep System.Double = 0.08 optionalposition: 7
Connector path-position search step, from 0.0 to 1.0.
maxPositionShifts System.Int32 = 4 optionalposition: 8
Number of positive and negative connector path-position shifts to try.
optimizationPasses System.Int32 = 1 optionalposition: 9
Number of whole-page label optimization passes to run after the initial placement sweep.
public static IReadOnlyList<VisioComment> ResolvedComments(VisioPage page) #
Returns: IReadOnlyList<VisioComment>

Returns native Visio comments that are marked as done.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
public static VisioPage ResolveShapeOverlaps(VisioPage page, Double step = 0.25, Int32 maxAttempts = 24, Boolean includeContainers = false) #
Returns: VisioPage

Moves overlapping top-level shapes apart using a deterministic nearest-open-position search.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to update.
step System.Double = 0.25 optionalposition: 1
Search step in inches.
maxAttempts System.Int32 = 24 optionalposition: 2
Number of search rings to try around each overlapping shape.
includeContainers System.Boolean = false optionalposition: 3
Whether container and background surface shapes should be moved and treated as obstacles.
RouteConnectorsOrthogonalAroundShapes 2 overloads
public static VisioPage RouteConnectorsOrthogonalAroundShapes(VisioPage page, Double padding = 0.15, Int32 maxLanes = 12) #
Returns: VisioPage

Routes every connector on the page around unrelated top-level shapes using deterministic orthogonal lanes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page whose connectors should be rerouted.
padding System.Double = 0.15 optionalposition: 1
Padding added around each obstacle while testing route intersections.
maxLanes System.Int32 = 12 optionalposition: 2
Number of positive and negative routing lanes to try on each axis.
public static VisioPage RouteConnectorsOrthogonalAroundShapes(VisioPage page, VisioConnectorRoutingOptions options) #
Returns: VisioPage

Routes every connector on the page around unrelated top-level shapes using deterministic orthogonal lanes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page whose connectors should be rerouted.
options OfficeIMO.Visio.VisioConnectorRoutingOptions requiredposition: 1
Routing options controlling padding, lane search, and whether zones/containers count as obstacles.
SaveAsPng 2 overloads
public static Void SaveAsPng(VisioPage page, String path, VisioPngSaveOptions options = null) #
Returns: Void

Saves the selected document page as PNG without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Visio.VisioPngSaveOptions = null optionalposition: 2
public static Void SaveAsPng(VisioPage page, Stream stream, VisioPngSaveOptions options = null) #
Returns: Void

Saves the selected document page as PNG without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Visio.VisioPngSaveOptions = null optionalposition: 2
SaveAsSvg 2 overloads
public static Void SaveAsSvg(VisioPage page, String path, VisioSvgSaveOptions options = null) #
Returns: Void

Saves the selected document page as SVG without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Visio.VisioSvgSaveOptions = null optionalposition: 2
public static Void SaveAsSvg(VisioPage page, Stream stream, VisioSvgSaveOptions options = null) #
Returns: Void

Saves the selected document page as SVG without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Visio.VisioSvgSaveOptions = null optionalposition: 2
public static VisioShapeSelection SelectByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes created from a matching master universal name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
masterNameU System.String requiredposition: 1
Master universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static VisioShapeSelection SelectByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes with a matching shape name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static VisioShapeSelection SelectByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes with a matching universal shape name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
nameU System.String requiredposition: 1
Universal shape name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static VisioShapeSelection SelectCallouts(VisioPage page) #
Returns: VisioShapeSelection

Selects shapes marked as OfficeIMO callouts or annotations.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static VisioShapeSelection SelectConnectedComponent(VisioPage page, VisioShape shape, Boolean includeStart = true) #
Returns: VisioShapeSelection

Selects every shape reachable from the provided shape through connectors.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Starting shape.
includeStart System.Boolean = true optionalposition: 2
Whether the starting shape should be included in the returned component.
public static VisioConnectorSelection SelectConnectedConnectors(VisioPage page, VisioShape shape) #
Returns: VisioConnectorSelection

Selects connectors that either start or end at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected to or from.
public static VisioConnectorSelection SelectConnectors(VisioPage page, Func<VisioConnector, Boolean> predicate) #
Returns: VisioConnectorSelection

Selects connectors matching a predicate for bulk editing.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioConnector,System.Boolean} requiredposition: 1
Predicate used to include connectors.
public static VisioConnectorSelection SelectConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioConnectorSelection

Selects connectors assigned to a page layer.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
layerName System.String requiredposition: 1
Layer name or universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
SelectConnectorsWithProtection 2 overloads
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page) #
Returns: VisioConnectorSelection

Selects connectors that have at least one explicit protection cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page, Func<VisioProtection, Boolean> predicate) #
Returns: VisioConnectorSelection

Selects connectors whose protection state matches the predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean} requiredposition: 1
Protection predicate.
SelectContainedIn 2 overloads
public static VisioShapeSelection SelectContainedIn(VisioPage page, VisioShapeBounds bounds) #
Returns: VisioShapeSelection

Selects shapes whose bounds are fully contained by the provided bounds.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
bounds OfficeIMO.Visio.VisioShapeBounds requiredposition: 1
Containing bounds.
public static VisioShapeSelection SelectContainedIn(VisioPage page, VisioShape container, Boolean includeContainer = false) #
Returns: VisioShapeSelection

Selects shapes whose bounds are fully contained by the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose bounds are used as the containing area.
includeContainer System.Boolean = false optionalposition: 2
Whether the containing shape itself should be included.
public static VisioShapeSelection SelectContainers(VisioPage page) #
Returns: VisioShapeSelection

Selects shapes marked as Visio-native containers.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static VisioShapeSelection SelectContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes whose text contains the provided value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
text System.String requiredposition: 1
Text fragment to find.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static VisioConnectorSelection SelectIncomingConnectors(VisioPage page, VisioShape shape) #
Returns: VisioConnectorSelection

Selects connectors that end at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected to.
SelectIntersecting 2 overloads
public static VisioShapeSelection SelectIntersecting(VisioPage page, VisioShapeBounds bounds) #
Returns: VisioShapeSelection

Selects shapes whose bounds intersect the provided bounds.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
bounds OfficeIMO.Visio.VisioShapeBounds requiredposition: 1
Bounds to test against.
public static VisioShapeSelection SelectIntersecting(VisioPage page, VisioShape shape, Boolean includeSelf = false) #
Returns: VisioShapeSelection

Selects shapes whose bounds intersect the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose bounds are used for the test.
includeSelf System.Boolean = false optionalposition: 2
Whether the reference shape itself should be included.
public static VisioShapeSelection SelectLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes assigned to a page layer.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
layerName System.String requiredposition: 1
Layer name or universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static VisioConnectorSelection SelectOutgoingConnectors(VisioPage page, VisioShape shape) #
Returns: VisioConnectorSelection

Selects connectors that start at the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape connected from.
public static VisioShapeSelection SelectPathBetween(VisioPage page, VisioShape from, VisioShape to, Boolean includeEndpoints = true) #
Returns: VisioShapeSelection

Selects the shortest shape path between two connected shapes.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
from OfficeIMO.Visio.VisioShape requiredposition: 1
Starting shape.
to OfficeIMO.Visio.VisioShape requiredposition: 2
Target shape.
includeEndpoints System.Boolean = true optionalposition: 3
Whether the starting and target shapes should be included.
public static VisioShapeSelection SelectShapes(VisioPage page, Func<VisioShape, Boolean> predicate) #
Returns: VisioShapeSelection

Selects shapes matching a predicate for bulk editing.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioShape,System.Boolean} requiredposition: 1
Predicate used to include shapes.
SelectWithData 3 overloads
public static VisioShapeSelection SelectWithData(VisioPage page, String key) #
Returns: VisioShapeSelection

Selects shapes that contain the provided data key.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
public static VisioShapeSelection SelectWithData(VisioPage page, String key, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes that contain the provided data key and value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
value System.String requiredposition: 2
Data value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static VisioShapeSelection SelectWithData(VisioPage page, String key, Func<String, Boolean> predicate) #
Returns: VisioShapeSelection

Selects shapes whose Shape Data value for the provided key matches a predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
predicate System.Func{System.String,System.Boolean} requiredposition: 2
Predicate that receives the current Shape Data value.
SelectWithProtection 2 overloads
public static VisioShapeSelection SelectWithProtection(VisioPage page) #
Returns: VisioShapeSelection

Selects shapes that have at least one explicit protection cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static VisioShapeSelection SelectWithProtection(VisioPage page, Func<VisioShapeProtection, Boolean> predicate) #
Returns: VisioShapeSelection

Selects shapes whose protection state matches the predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean} requiredposition: 1
Protection predicate.
SelectWithShapeData 3 overloads
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name) #
Returns: VisioShapeSelection

Selects shapes that contain a Visio Shape Data row.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes with a matching Visio Shape Data value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
value System.String requiredposition: 2
Shape Data value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name, Func<String, Boolean> predicate) #
Returns: VisioShapeSelection

Selects shapes whose Visio Shape Data value for the provided row name matches a predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
predicate System.Func{System.String,System.Boolean} requiredposition: 2
Predicate that receives the current Shape Data value.
SelectWithUserCell 2 overloads
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name) #
Returns: VisioShapeSelection

Selects shapes that contain a Visio User cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
User cell row name.
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: VisioShapeSelection

Selects shapes with a matching Visio User cell value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
User cell row name.
value System.String requiredposition: 2
User cell value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes created from a matching master universal name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
masterNameU System.String requiredposition: 1
Master universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes with a matching shape name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes with a matching universal shape name.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
nameU System.String requiredposition: 1
Universal shape name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
ShapesContainedIn 2 overloads
public static IReadOnlyList<VisioShape> ShapesContainedIn(VisioPage page, VisioShapeBounds bounds) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose bounds are fully contained by the provided bounds.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
bounds OfficeIMO.Visio.VisioShapeBounds requiredposition: 1
Containing bounds.
public static IReadOnlyList<VisioShape> ShapesContainedIn(VisioPage page, VisioShape container, Boolean includeContainer = false) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose bounds are fully contained by the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
container OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose bounds are used as the containing area.
includeContainer System.Boolean = false optionalposition: 2
Whether the containing shape itself should be included.
public static IReadOnlyList<VisioShape> ShapesContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose text contains the provided value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
text System.String requiredposition: 1
Text fragment to find.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes assigned to a page layer.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
layerName System.String requiredposition: 1
Layer name or universal name.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 2
String comparison used for matching.
ShapesIntersecting 2 overloads
public static IReadOnlyList<VisioShape> ShapesIntersecting(VisioPage page, VisioShapeBounds bounds) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose bounds intersect the provided bounds.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
bounds OfficeIMO.Visio.VisioShapeBounds requiredposition: 1
Bounds to test against.
public static IReadOnlyList<VisioShape> ShapesIntersecting(VisioPage page, VisioShape shape, Boolean includeSelf = false) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose bounds intersect the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
shape OfficeIMO.Visio.VisioShape requiredposition: 1
Shape whose bounds are used for the test.
includeSelf System.Boolean = false optionalposition: 2
Whether the reference shape itself should be included.
ShapesWithData 3 overloads
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key) #
Returns: IReadOnlyList<VisioShape>

Returns shapes that contain the provided data key.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes that contain the provided data key and value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
value System.String requiredposition: 2
Data value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithData(VisioPage page, String key, Func<String, Boolean> predicate) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose Shape Data value for the provided key matches a predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
key System.String requiredposition: 1
Data key.
predicate System.Func{System.String,System.Boolean} requiredposition: 2
Predicate that receives the current Shape Data value.
ShapesWithProtection 2 overloads
public static IReadOnlyList<VisioShape> ShapesWithProtection(VisioPage page) #
Returns: IReadOnlyList<VisioShape>

Returns shapes that have at least one explicit protection cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
public static IReadOnlyList<VisioShape> ShapesWithProtection(VisioPage page, Func<VisioShapeProtection, Boolean> predicate) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose protection state matches the predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean} requiredposition: 1
Protection predicate.
ShapesWithShapeData 3 overloads
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name) #
Returns: IReadOnlyList<VisioShape>

Returns shapes that contain a Visio Shape Data row.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes with a matching Visio Shape Data value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
value System.String requiredposition: 2
Shape Data value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithShapeData(VisioPage page, String name, Func<String, Boolean> predicate) #
Returns: IReadOnlyList<VisioShape>

Returns shapes whose Visio Shape Data value for the provided row name matches a predicate.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
Shape Data row name.
predicate System.Func{System.String,System.Boolean} requiredposition: 2
Predicate that receives the current Shape Data value.
ShapesWithUserCell 2 overloads
public static IReadOnlyList<VisioShape> ShapesWithUserCell(VisioPage page, String name) #
Returns: IReadOnlyList<VisioShape>

Returns shapes that contain a Visio User cell.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
User cell row name.
public static IReadOnlyList<VisioShape> ShapesWithUserCell(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #
Returns: IReadOnlyList<VisioShape>

Returns shapes with a matching Visio User cell value.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
Page to query.
name System.String requiredposition: 1
User cell row name.
value System.String requiredposition: 2
User cell value.
comparison System.StringComparison = OrdinalIgnoreCase optionalposition: 3
String comparison used for matching.
public static Byte[] ToPng(VisioPage page, VisioPngSaveOptions options = null) #
Returns: Byte[]

Renders the selected document page to PNG bytes without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
options OfficeIMO.Visio.VisioPngSaveOptions = null optionalposition: 1
public static String ToSvg(VisioPage page, VisioSvgSaveOptions options = null) #
Returns: String

Renders the selected document page to SVG without requiring Microsoft Visio desktop automation.

Parameters

document OfficeIMO.Visio.VisioDocument requiredposition: 0
options OfficeIMO.Visio.VisioSvgSaveOptions = null optionalposition: 1
public static IReadOnlyList<VisioComment> UnresolvedComments(VisioPage page) #
Returns: IReadOnlyList<VisioComment>

Returns native Visio comments that are not marked as done.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
public static VisioComment UpdateCommentText(VisioPage page, Int32 commentId, String text, Nullable<DateTimeOffset> editedAt = null) #
Returns: VisioComment

Updates a native Visio comment's text by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
text System.String requiredposition: 2
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 3