Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeVisioVisualBookLink

OfficeIMO.ChartForgeX

Namespace
OfficeIMO.ChartForgeX
Assembly
OfficeIMO.ChartForgeX
Source revision
ba882f6b0d07 with working tree changes
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

Explore 1 API references to this type

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

Accepted by parameters 1

Constructors

public OfficeVisioVisualBookLink(int sourcePageNumber, string sourceEntityId, int targetPageNumber, string targetEntityId, string? relationshipId = null) #

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

Parameters

sourcePageNumber int required
sourceEntityId string required
targetPageNumber int required
targetEntityId string required
relationshipId string? = null optional

Properties

public int SourcePageNumber { get; } #

Gets the one-based page containing the source entity.

public string SourceEntityId { get; } #

Gets the projected source shape identifier.

public int 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.