API Reference
Class
VisioFluentShape
Fluent helper for configuring a shape (text, stroke, fill).
Inheritance
- Object
- VisioFluentShape
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method VisioFluentShape.Bold
- Method VisioFluentShape.ClearLayoutPolicy
- Method VisioFluentShape.ConnectorPermeability
- Method VisioFluentShape.Fill
- Method VisioFluentShape.Font
- Method VisioFluentShape.FontSize
- Method VisioFluentShape.Hyperlink
- Method VisioFluentShape.Layer
- Method VisioFluentShape.PlacementFlip
- Method VisioFluentShape.PlacementOnTop
- Method VisioFluentShape.PlacementStyle
- Method VisioFluentShape.Plow
- Method VisioFluentShape.Protect
- Method VisioFluentShape.ShapeData
- Method VisioFluentShape.ShapeSplitting
- Method VisioFluentShape.Stroke
- Method VisioFluentShape.Style
- Method VisioFluentShape.Text
- Method VisioFluentShape.TextAlignment
- Method VisioFluentShape.TextColor
- Method VisioFluentShape.UserCell
Accepted by parameters
- Method VisioFluentPage.Shape
- Method VisioFluentPage.TextBox
- Method VisioFluentPage.Title
Constructors
VisioFluentShape(OfficeIMO.Visio.VisioShape shape) #Initializes a new shape wrapper.
Parameters
- shape OfficeIMO.Visio.VisioShape
- Underlying shape model.
Methods
public VisioFluentShape Bold(Boolean enabled = true) #Returns:
VisioFluentShapeSets whether the whole-shape text is bold.
Parameters
- enabled System.Boolean = true
public VisioFluentShape ClearLayoutPolicy() #Returns:
VisioFluentShapeClears explicit Shape Layout override cells.
public VisioFluentShape ConnectorPermeability(Boolean horizontal = true, Boolean vertical = true) #Returns:
VisioFluentShapeAllows or disallows connector routing through this shape.
Parameters
- horizontal System.Boolean = true
- vertical System.Boolean = true
public VisioFluentShape Fill(OfficeColor color, Int32 pattern = 1) #Returns:
VisioFluentShapeSets fill color and optional pattern.
Parameters
- color OfficeIMO.Drawing.OfficeColor
- Fill color.
- pattern System.Int32 = 1
- Fill pattern index (default 1=Solid).
public VisioFluentShape Font(String fontFamily) #Returns:
VisioFluentShapeSets the whole-shape text font family.
Parameters
- fontFamily System.String
public VisioFluentShape FontSize(Double size) #Returns:
VisioFluentShapeSets the whole-shape text size in points.
Parameters
- size System.Double
public VisioFluentShape Hyperlink(String address, String description = null, String subAddress = null) #Returns:
VisioFluentShapeAdds a hyperlink to the shape.
Parameters
- address System.String
- External hyperlink address.
- description System.String = null
- Optional display description.
- subAddress System.String = null
- Optional internal sub-address.
public VisioFluentShape Layer(String layerName) #Returns:
VisioFluentShapeAdds the shape to a page layer.
Parameters
- layerName System.String
- Layer name.
public VisioFluentShape PlacementFlip(VisioPlacementFlip flip) #Returns:
VisioFluentShapeSets the shape-level Visio placement flip behavior.
Parameters
- flip OfficeIMO.Visio.VisioPlacementFlip
public VisioFluentShape PlacementOnTop(Boolean allowed = true) #Returns:
VisioFluentShapeAllows or disallows placing other shapes on top of this shape during layout.
Parameters
- allowed System.Boolean = true
public VisioFluentShape PlacementStyle(VisioPlacementStyle style) #Returns:
VisioFluentShapeSets the shape-level Visio placement style.
Parameters
- style OfficeIMO.Visio.VisioPlacementStyle
public VisioFluentShape Plow(VisioShapePlowCode code) #Returns:
VisioFluentShapeSets the shape-level Visio plow behavior.
Parameters
- code OfficeIMO.Visio.VisioShapePlowCode
public VisioFluentShape Protect(Action<VisioShapeProtection> configure) #Returns:
VisioFluentShapeConfigures ShapeSheet protection cells.
Parameters
- configure System.Action{OfficeIMO.Visio.VisioShapeProtection}
- Protection configuration delegate.
public VisioFluentShape ShapeData(String name, String value, String label = null, Nullable<VisioShapeDataType> type = null, String prompt = null, String format = null) #Returns:
VisioFluentShapeSets or replaces a Visio Shape Data row.
Parameters
- name System.String
- Shape Data row name.
- value System.String
- Shape Data value.
- label System.String = null
- Optional label shown in Visio's Shape Data window.
- type System.Nullable{OfficeIMO.Visio.VisioShapeDataType} = null
- Optional Shape Data type.
- prompt System.String = null
- Optional help prompt.
- format System.String = null
- Optional format picture or list values.
public VisioFluentShape ShapeSplitting(Boolean canSplit = true, Boolean canBeSplit = true) #Returns:
VisioFluentShapeAllows or disallows this shape splitting other shapes.
Parameters
- canSplit System.Boolean = true
- canBeSplit System.Boolean = true
public VisioFluentShape Stroke(OfficeColor color, Double weight = 0.0138889, Int32 pattern = 1) #Returns:
VisioFluentShapeSets stroke color, weight (inches), and optional pattern.
Parameters
- color OfficeIMO.Drawing.OfficeColor
- Line color.
- weight System.Double = 0.0138889
- Line weight in inches.
- pattern System.Int32 = 1
- Line pattern index (default 1=Solid).
public VisioFluentShape Style(VisioShapeStyle style) #Returns:
VisioFluentShapeApplies a reusable shape style.
Parameters
- style OfficeIMO.Visio.VisioShapeStyle
- Shape style to apply.
public VisioFluentShape Text(String text) #Returns:
VisioFluentShapeSets shape text.
Parameters
- text System.String
- Text content.
public VisioFluentShape TextAlignment(VisioTextHorizontalAlignment horizontal, Nullable<VisioTextVerticalAlignment> vertical = null) #Returns:
VisioFluentShapeSets whole-shape text alignment.
Parameters
- horizontal OfficeIMO.Visio.VisioTextHorizontalAlignment
- vertical System.Nullable{OfficeIMO.Visio.VisioTextVerticalAlignment} = null
public VisioFluentShape TextColor(OfficeColor color) #Returns:
VisioFluentShapeSets the whole-shape text color.
Parameters
- color OfficeIMO.Drawing.OfficeColor
public VisioFluentShape UserCell(String name, String value, String unit = null, String formula = null, String prompt = null) #Returns:
VisioFluentShapeSets or replaces a Visio User cell.
Parameters
- name System.String
- User cell row name.
- value System.String
- User cell value.
- unit System.String = null
- Optional Visio unit code.
- formula System.String = null
- Optional ShapeSheet formula.
- prompt System.String = null
- Optional prompt value.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object