A bookmark represents a named contiguous area in a document, with both a starting position and an ending position. You can use bookmarks to mark a location in a document, or as a container for text in a document. It can be as small as just the insertion point, or it can be as large as the entire document. NOTE: A comment is considered to be a types of bookmark. More...

Inheritance diagram for SolidFramework.Model.Plumbing.Bookmark:

Public Member Functions
override void	Dispose ()

SolidFramework.Model.Plumbing.Bookmark	GetChild (int index)

override string	ToString ()

int	GetID ()

SolidFramework.Model.Plumbing.SolidObjectType	GetObjectType ()

bool	Equals (SolidFramework.Model.Plumbing.SolidObject other)

override bool	Equals (object obj)

override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.Model.Plumbing.SolidObject obj1, SolidFramework.Model.Plumbing.SolidObject obj2)

static bool	operator!= (SolidFramework.Model.Plumbing.SolidObject obj1, SolidFramework.Model.Plumbing.SolidObject obj2)

Properties
string	Name `[get]`
	Gets the name of the bookmark. More...

int	Count `[get]`
	Gets number of child bookmarks. More...

int	PageNumber `[get]`
	Gets the page number where the bookmark is located. More...

bool	IsHidden `[get]`
	Gets whether the bookmark is hidden. More...

SolidFramework.Model.Plumbing.BookmarkType	Type `[get]`
	Gets the type of bookmark. More...

Detailed Description

A bookmark represents a named contiguous area in a document, with both a starting position and an ending position. You can use bookmarks to mark a location in a document, or as a container for text in a document. It can be as small as just the insertion point, or it can be as large as the entire document. NOTE: A comment is considered to be a types of bookmark.

Member Function Documentation

◆ Dispose()

override void SolidFramework.Model.Plumbing.Bookmark.Dispose ( )

virtual

Reimplemented from SolidFramework.Model.Plumbing.SolidObject.

Property Documentation

◆ Count

int SolidFramework.Model.Plumbing.Bookmark.Count

get

Gets number of child bookmarks.

Returns: The number of child bookmarks owned by this bookmark.

◆ IsHidden

bool SolidFramework.Model.Plumbing.Bookmark.IsHidden

get

Gets whether the bookmark is hidden.

Returns: true if the the bookmark is hidden, otherwise false.

◆ Name

string SolidFramework.Model.Plumbing.Bookmark.Name

get

Gets the name of the bookmark.

Returns: The name of the bookmark.

◆ PageNumber

int SolidFramework.Model.Plumbing.Bookmark.PageNumber

get

Gets the page number where the bookmark is located.

Returns: The number of the page on whcih the bookmark is located.

◆ Type

SolidFramework.Model.Plumbing.BookmarkType SolidFramework.Model.Plumbing.Bookmark.Type

get

Gets the type of bookmark.

Returns: A BookmarkType which specifies the type of object that this is

Public Member Functions

Static Public Member Functions

Properties