API Reference
Class
VisioFluentDocument
Provides a fluent wrapper for VisioDocument allowing chained configuration.
Inheritance
- Object
- VisioFluentDocument
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 VisioFluentDocument.ApplyStencilMigration
- Method VisioFluentDocument.ApplyStencilMigration
- Method VisioFluentDocument.BackgroundPage
- Method VisioFluentDocument.BackgroundPage
- Method VisioFluentDocument.ExistingPage
- Method VisioFluentDocument.ExistingPage
- Method VisioFluentDocument.FirstPage
- Method VisioFluentDocument.Info
- Method VisioFluentDocument.Page
- Method VisioFluentDocument.Page
- Method VisioFluentDocument.PageOrAdd
- Method VisioFluentDocument.PageOrAdd
- Method VisioFluentDocument.Polish
- Method VisioFluentDocumentExtensions.AsFluent
- Method VisioFluentPage.EndPage
- Extension method VisioDocument.AsFluent
Accepted by parameters
- Constructor VisioFluentPage.VisioFluentPage
Constructors
public VisioFluentDocument(VisioDocument document) #Initializes a new instance of the VisioFluentDocument class.
Parameters
- document OfficeIMO.Visio.VisioDocument
- The underlying VisioDocument.
Methods
ApplyStencilMigration 2 overloads
public VisioFluentDocument ApplyStencilMigration(VisioStencilMigrationMap map) #Returns:
VisioFluentDocumentApplies a reusable stencil migration map to all foreground pages in the document.
Parameters
- map OfficeIMO.Visio.VisioStencilMigrationMap
public VisioFluentDocument ApplyStencilMigration(VisioStencilMigrationPlan plan, VisioStencilMigrationMap map) #Returns:
VisioFluentDocumentApplies a previously reviewed stencil migration plan to the document after validating that the diagram still matches the plan.
Parameters
- plan OfficeIMO.Visio.VisioStencilMigrationPlan
- map OfficeIMO.Visio.VisioStencilMigrationMap
BackgroundPage 2 overloads
public VisioFluentDocument BackgroundPage(String name, Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentAdds a Visio background page and configures it.
Parameters
- name System.String
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
public VisioFluentDocument BackgroundPage(String name, Double width, Double height, VisioMeasurementUnit unit, Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentAdds a sized Visio background page and configures it.
Parameters
- name System.String
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
public VisioDocument End() #Returns:
VisioDocumentEnds fluent configuration and returns the underlying document.
ExistingPage 2 overloads
public VisioFluentDocument ExistingPage(Int32 pageIndex, Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentConfigures an existing page by zero-based index without adding a new page.
Parameters
- pageIndex System.Int32
- Zero-based page index.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the page.
public VisioFluentDocument ExistingPage(String name, Action<VisioFluentPage> configure, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioFluentDocumentConfigures an existing page by name without adding a duplicate page.
Parameters
- name System.String
- Page name to find.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the page.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used when matching page names.
public VisioFluentDocument FirstPage(Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentConfigures the first page in an existing document.
Parameters
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the first page.
public VisioFluentDocument Info(Action<InfoBuilder> action) #Returns:
VisioFluentDocumentProvides fluent access to document information.
Parameters
- action System.Action{OfficeIMO.Visio.Fluent.InfoBuilder}
- Action that receives an InfoBuilder.
Page 3 overloads
public VisioFluentDocument Page(VisioPage page, Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentAdds a page using a direct fluent style (no Add*/With* names) and configures it. Mirrors patterns from Markdown/Excel/PowerPoint fluent APIs.
Parameters
- name System.String
- Page name.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration for shapes/connectors on the page.
public VisioFluentDocument Page(String name, Double width, Double height, VisioMeasurementUnit unit, Action<VisioFluentPage> configure) #Returns:
VisioFluentDocumentAdds a page with explicit size and configures it.
Parameters
- name System.String
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
Page(OfficeIMO.Visio.VisioPage page, System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage} configure) #Configures an existing page instance that belongs to this document.
Parameters
- page OfficeIMO.Visio.VisioPage
- Existing page instance.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the page.
PageOrAdd 2 overloads
public VisioFluentDocument PageOrAdd(String name, Action<VisioFluentPage> configure, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioFluentDocumentConfigures an existing page by name or adds it when it is missing.
Parameters
- name System.String
- Page name to find or create.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the page.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used when matching page names.
public VisioFluentDocument PageOrAdd(String name, Double width, Double height, VisioMeasurementUnit unit, Action<VisioFluentPage> configure, StringComparison comparison = OrdinalIgnoreCase) #Returns:
VisioFluentDocumentConfigures an existing page by name or adds it with explicit size when it is missing.
Parameters
- name System.String
- Page name to find or create.
- width System.Double
- Page width to use when creating a missing page.
- height System.Double
- Page height to use when creating a missing page.
- unit OfficeIMO.Visio.VisioMeasurementUnit
- Measurement unit for a newly created page.
- configure System.Action{OfficeIMO.Visio.Fluent.VisioFluentPage}
- Configuration to apply to the page.
- comparison System.StringComparison = OrdinalIgnoreCase
- String comparison used when matching page names.
public VisioFluentDocument Polish(VisioDiagramPolishOptions options = null) #Returns:
VisioFluentDocumentApplies high-level deterministic cleanup to all foreground pages.
Parameters
- options OfficeIMO.Visio.VisioDiagramPolishOptions = null
- Optional polish settings.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object