API Reference
Class
VisioContainerEditingExtensions
Editing helpers for maintaining Visio-native container membership and bounds.
Inheritance
- Object
- VisioContainerEditingExtensions
Methods
AddToContainer 3 overloads
public static VisioShape AddToContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #Returns:
VisioShapeAdds one member shape to a Visio-native container and optionally resizes the container around all current members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
AddToContainer(OfficeIMO.Visio.VisioPage page, OfficeIMO.Visio.VisioShape container, System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape} members, System.Boolean resizeToFit, OfficeIMO.Visio.VisioContainerOptions resizeOptions) #Adds member shapes to a Visio-native container and optionally resizes the container around all current members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- members System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- resizeToFit System.Boolean
- resizeOptions OfficeIMO.Visio.VisioContainerOptions
public static VisioShapeSelection AddToContainer(VisioShapeSelection selection, VisioShape container, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #Returns:
VisioShapeSelectionAdds all selected shapes to an existing Visio-native container.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- container OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static VisioShape ApplyContainerOptions(VisioPage page, VisioShape container, VisioContainerOptions options, Boolean refit = false) #Returns:
VisioShapeApplies native container metadata and visual style to an existing Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to update.
- options OfficeIMO.Visio.VisioContainerOptions
- Container metadata and style options.
- refit System.Boolean = false
- Whether the container should be refit around current members after metadata is applied.
public static VisioShape ConfigureContainer(VisioPage page, VisioShape container, Action<VisioContainerOptions> configure, Boolean refit = false) #Returns:
VisioShapeUpdates native container metadata and visual style using a callback initialized from the current container state.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to update.
- configure System.Action{OfficeIMO.Visio.VisioContainerOptions}
- Option callback.
- refit System.Boolean = false
- Whether the container should be refit around current members after metadata is applied.
public static VisioContainerInfo GetContainerInfo(VisioPage page, VisioShape container) #Returns:
VisioContainerInfoGets typed metadata and membership information for a Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static IReadOnlyList<VisioShape> GetContainerMembers(VisioPage page, VisioShape container) #Returns:
IReadOnlyList<VisioShape>Gets the shapes currently referenced by a Visio-native container.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static VisioContainerOptions GetContainerOptions(VisioPage page, VisioShape container) #Returns:
VisioContainerOptionsGets editable options initialized from a Visio-native container's current metadata and visual style.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape.
public static VisioShape RefitContainer(VisioPage page, VisioShape container, VisioContainerOptions options = null) #Returns:
VisioShapeResizes a Visio-native container so it encloses its current typed members.
Parameters
- page OfficeIMO.Visio.VisioPage
- Page that owns the container.
- container OfficeIMO.Visio.VisioShape
- Container shape to resize.
- options OfficeIMO.Visio.VisioContainerOptions = null
- Optional margin and heading settings used for the calculated bounds.
RemoveFromContainer 3 overloads
public static VisioShape RemoveFromContainer(VisioPage page, VisioShape container, IEnumerable<VisioShape> members, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #Returns:
VisioShapeRemoves one member shape from a Visio-native container and optionally resizes the container around remaining members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- member OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
RemoveFromContainer(OfficeIMO.Visio.VisioPage page, OfficeIMO.Visio.VisioShape container, System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape} members, System.Boolean resizeToFit, OfficeIMO.Visio.VisioContainerOptions resizeOptions) #Removes member shapes from a Visio-native container and optionally resizes the container around remaining members.
Parameters
- page OfficeIMO.Visio.VisioPage
- container OfficeIMO.Visio.VisioShape
- members System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioShape}
- resizeToFit System.Boolean
- resizeOptions OfficeIMO.Visio.VisioContainerOptions
public static VisioShapeSelection RemoveFromContainer(VisioShapeSelection selection, VisioShape container, Boolean resizeToFit = true, VisioContainerOptions resizeOptions = null) #Returns:
VisioShapeSelectionRemoves all selected shapes from an existing Visio-native container.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- container OfficeIMO.Visio.VisioShape
- resizeToFit System.Boolean = true
- resizeOptions OfficeIMO.Visio.VisioContainerOptions = null
public static VisioShape WrapInContainer(VisioShapeSelection selection, String id, String text, VisioContainerOptions options = null) #Returns:
VisioShapeCreates a Visio-native container around the selected shapes.
Parameters
- selection OfficeIMO.Visio.VisioShapeSelection
- id System.String
- text System.String
- options OfficeIMO.Visio.VisioContainerOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object