API Reference
Class
VisioPageQueryExtensions
Query and selection helpers for editing Visio pages by semantics instead of by list indexes.
Inheritance
- Object
- VisioPageQueryExtensions
Methods
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
- Page to query.
public static IReadOnlyList<VisioShape> Callouts(VisioPage page) #Returns:
IReadOnlyList<VisioShape>Returns shapes marked as OfficeIMO callouts or annotations.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
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
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- 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
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape whose neighbors should be returned.
public static IReadOnlyList<VisioConnector> ConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioConnector>Returns connectors assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioConnector> ConnectorsWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioConnector>Returns connectors that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioConnector> ConnectorsWithHyperlinks(VisioPage page) #Returns:
IReadOnlyList<VisioConnector>Returns connectors that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
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
- 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
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean}
- Protection predicate.
public static IReadOnlyList<VisioShape> Containers(VisioPage page) #Returns:
IReadOnlyList<VisioShape>Returns shapes marked as Visio-native containers.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShape FindShapeById(VisioPage page, String id) #Returns:
VisioShapeFinds a shape by identifier, including shapes nested inside groups.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- id System.String
- Shape identifier.
public static IReadOnlyList<VisioConnector> IncomingConnectors(VisioPage page, VisioShape shape) #Returns:
IReadOnlyList<VisioConnector>Returns connectors that end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to.
public static IReadOnlyList<VisioConnector> OutgoingConnectors(VisioPage page, VisioShape shape) #Returns:
IReadOnlyList<VisioConnector>Returns connectors that start at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected from.
public static VisioShapeSelection SelectByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes created from a matching master universal name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- masterNameU System.String
- Master universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes with a matching shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes with a matching universal shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- nameU System.String
- Universal shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectCallouts(VisioPage page) #Returns:
VisioShapeSelectionSelects shapes marked as OfficeIMO callouts or annotations.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioConnectorSelection SelectConnectedConnectors(VisioPage page, VisioShape shape) #Returns:
VisioConnectorSelectionSelects connectors that either start or end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to or from.
public static VisioConnectorSelection SelectConnectors(VisioPage page, Func<VisioConnector, Boolean> predicate) #Returns:
VisioConnectorSelectionSelects connectors matching a predicate for bulk editing.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioConnector,System.Boolean}
- Predicate used to include connectors.
public static VisioConnectorSelection SelectConnectorsInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioConnectorSelectionSelects connectors assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectConnectorsWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioConnectorSelectionSelects connectors that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectConnectorsWithHyperlinks(VisioPage page) #Returns:
VisioConnectorSelectionSelects connectors that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
SelectConnectorsWithProtection 2 overloads
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page) #Returns:
VisioConnectorSelectionSelects connectors that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioConnectorSelection SelectConnectorsWithProtection(VisioPage page, Func<VisioProtection, Boolean> predicate) #Returns:
VisioConnectorSelectionSelects connectors whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioProtection,System.Boolean}
- Protection predicate.
public static VisioShapeSelection SelectContainers(VisioPage page) #Returns:
VisioShapeSelectionSelects shapes marked as Visio-native containers.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes whose text contains the provided value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- text System.String
- Text fragment to find.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectIncomingConnectors(VisioPage page, VisioShape shape) #Returns:
VisioConnectorSelectionSelects connectors that end at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected to.
public static VisioShapeSelection SelectLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioConnectorSelection SelectOutgoingConnectors(VisioPage page, VisioShape shape) #Returns:
VisioConnectorSelectionSelects connectors that start at the provided shape.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- shape OfficeIMO.Visio.VisioShape
- Shape connected from.
public static VisioShapeSelection SelectShapes(VisioPage page, Func<VisioShape, Boolean> predicate) #Returns:
VisioShapeSelectionSelects shapes matching a predicate for bulk editing.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShape,System.Boolean}
- Predicate used to include shapes.
SelectWithData 2 overloads
public static VisioShapeSelection SelectWithData(VisioPage page, String key) #Returns:
VisioShapeSelectionSelects shapes that contain the provided data key.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
public static VisioShapeSelection SelectWithData(VisioPage page, String key, String value, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes that contain the provided data key and value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- key System.String
- Data key.
- value System.String
- Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static VisioShapeSelection SelectWithHyperlinks(VisioPage page) #Returns:
VisioShapeSelectionSelects shapes that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
SelectWithProtection 2 overloads
public static VisioShapeSelection SelectWithProtection(VisioPage page) #Returns:
VisioShapeSelectionSelects shapes that have at least one explicit protection cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
public static VisioShapeSelection SelectWithProtection(VisioPage page, Func<VisioShapeProtection, Boolean> predicate) #Returns:
VisioShapeSelectionSelects shapes whose protection state matches the predicate.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean}
- Protection predicate.
SelectWithShapeData 2 overloads
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name) #Returns:
VisioShapeSelectionSelects shapes that contain a Visio Shape Data row.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
public static VisioShapeSelection SelectWithShapeData(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes with a matching Visio Shape Data value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape Data row name.
- value System.String
- Shape Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
SelectWithUserCell 2 overloads
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name) #Returns:
VisioShapeSelectionSelects shapes that contain a Visio User cell.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
public static VisioShapeSelection SelectWithUserCell(VisioPage page, String name, String value, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioShapeSelectionSelects shapes with a matching Visio User cell value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- User cell row name.
- value System.String
- User cell value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByMaster(VisioPage page, String masterNameU, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes created from a matching master universal name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- masterNameU System.String
- Master universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByName(VisioPage page, String name, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes with a matching shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- name System.String
- Shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesByNameU(VisioPage page, String nameU, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes with a matching universal shape name.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- nameU System.String
- Universal shape name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesContainingText(VisioPage page, String text, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes whose text contains the provided value.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- text System.String
- Text fragment to find.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesInLayer(VisioPage page, String layerName, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes assigned to a page layer.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- layerName System.String
- Layer name or universal name.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
ShapesWithData 2 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
- Page to query.
- key System.String
- 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
- Page to query.
- key System.String
- Data key.
- value System.String
- Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithHyperlink(VisioPage page, String address, StringComparison comparison = OrdinalIgnoreCase) #Returns:
IReadOnlyList<VisioShape>Returns shapes that contain a hyperlink with the provided address.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
- address System.String
- Hyperlink address.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
public static IReadOnlyList<VisioShape> ShapesWithHyperlinks(VisioPage page) #Returns:
IReadOnlyList<VisioShape>Returns shapes that contain at least one hyperlink.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page to query.
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
- 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
- Page to query.
- predicate System.Func{OfficeIMO.Visio.VisioShapeProtection,System.Boolean}
- Protection predicate.
ShapesWithShapeData 2 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
- Page to query.
- name System.String
- 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
- Page to query.
- name System.String
- Shape Data row name.
- value System.String
- Shape Data value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.
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
- Page to query.
- name System.String
- 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
- Page to query.
- name System.String
- User cell row name.
- value System.String
- User cell value.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used for matching.