# OfficeVisioVisualBookLink

Describes navigation between two native entities on different pages in a Visio book.

Class 

`OfficeIMO.ChartForgeX`

**Namespace**

`OfficeIMO.ChartForgeX`

**Assembly**

`OfficeIMO.ChartForgeX`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeVisioVisualBookLinks.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L11)

**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

- Method [OfficeVisioVisualConversionExtensions.ToOfficeVisioBookWithNavigation](/api/chart-forge-x/officeimo-chartforgex-officevisiovisualconversionextensions/#method-toofficevisiobookwithnavigation-collections-generic-ienumerable-chartforgex-visualartifacts-visualartifactinterchangeenvelope-collections-generic-ienumerable-officeimo-chartforgex-officevisiovisualbooklink-officeimo-chartforgex-officevisiovisualbookoptions-officeimo-chartforgex-officevisiovisualoptions) parameter `links`

Filter members 

Show inherited

## Constructors

`public OfficeVisioVisualBookLink(int sourcePageNumber, string sourceEntityId, int targetPageNumber, string targetEntityId, string? relationshipId = null)` [#](#constructor-ctor-int32-string-int32-string-string)

[OfficeVisioVisualBookLinks.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L11)

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**

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public int SourcePageNumber { get; }` [#](#property-sourcepagenumber)

[OfficeVisioVisualBookLinks.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L25)

Gets the one-based page containing the source entity.

`public string SourceEntityId { get; }` [#](#property-sourceentityid)

[OfficeVisioVisualBookLinks.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L28)

Gets the projected source shape identifier.

`public int TargetPageNumber { get; }` [#](#property-targetpagenumber)

[OfficeVisioVisualBookLinks.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L31)

Gets the one-based page containing the target entity.

`public string TargetEntityId { get; }` [#](#property-targetentityid)

[OfficeVisioVisualBookLinks.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L34)

Gets the projected target shape identifier.

`public string? RelationshipId { get; }` [#](#property-relationshipid)

[OfficeVisioVisualBookLinks.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L37)

Gets the optional source relationship identifier retained with navigation metadata.

`public string? Description { get; set; }` [#](#property-description)

[OfficeVisioVisualBookLinks.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L40)

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

`public string? ReturnDescription { get; set; }` [#](#property-returndescription)

[OfficeVisioVisualBookLinks.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.ChartForgeX/OfficeVisioVisualBookLinks.cs#L43)

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

<!-- PowerForge markdown artifact sha256:51E8AC572F0800BEA9919BDB20AEA2667B8428AB6616421B930CAFC7A489AC54 -->
