Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeVisioVisualBookLink

Namespace OfficeIMO.ChartForgeX
Assembly OfficeIMO.ChartForgeX
Modifiers sealed

Describes navigation between two native entities on different pages in a Visio book. Page numbers are one-based so they can be used directly with report page indexes.

Inheritance

  • Object
  • OfficeVisioVisualBookLink

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Constructors

public OfficeVisioVisualBookLink(Int32 sourcePageNumber, String sourceEntityId, Int32 targetPageNumber, String targetEntityId, String relationshipId = null) #

Creates a cross-page link between two projected entity identifiers.

Parameters

sourcePageNumber System.Int32 requiredposition: 0
sourceEntityId System.String requiredposition: 1
targetPageNumber System.Int32 requiredposition: 2
targetEntityId System.String requiredposition: 3
relationshipId System.String = null optionalposition: 4

Properties

public Int32 SourcePageNumber { get; } #

Gets the one-based page containing the source entity.

public String SourceEntityId { get; } #

Gets the projected source shape identifier.

public Int32 TargetPageNumber { get; } #

Gets the one-based page containing the target entity.

public String TargetEntityId { get; } #

Gets the projected target shape identifier.

public String RelationshipId { get; } #

Gets the optional source relationship identifier retained with navigation metadata.

public String Description { get; set; } #

Gets or sets the forward-link description. A page and entity description is generated when omitted.

public String ReturnDescription { get; set; } #

Gets or sets the reciprocal-link description. A page and entity description is generated when omitted.