RhinoPageView

Public Class

A window that contains a single layout ‘page’

Inheritance Hierarchy

System.Object
Rhino.Display.RhinoView
Rhino.Display.RhinoPageView

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class RhinoPageView : RhinoView

The RhinoPageView type exposes the following members.

Properties

Name

Description

Public Property

ActiveDetail

Returns the active detail object. If no detail is active, or if the page is active, then null is returned.

Public Property

ActiveDetailId

Returns the id of the active detail. If no detail is active, or if the page is active, then Guid.Empty is returned.

Public Property

ActiveViewport

Gets the active viewport. The ActiveViewport is the same as the MainViewport for standard RhinoViews. In a RhinoPageView, the active viewport may be the RhinoViewport of a child detail object. Most of the time, you will use ActiveViewport unless you explicitly need to work with the main viewport.

(Overrides

RhinoView.ActiveViewport

Public Property

ActiveViewportID

Returns viewport ID for the active viewport. Faster than ActiveViewport function when working with page views.

(Inherited from RhinoView.)

Public Property

Bounds

Gets the size and location of the view including its non-client elements, in pixels, relative to the parent control.

(Inherited from RhinoView.)

Public Property

ClientRectangle

Gets the rectangle that represents the client area of the view.

(Inherited from RhinoView.)

Public Property

DisplayPipeline

Gets the display pipeline used for this view.

(Inherited from RhinoView.)

Public Property

Document

(Inherited from RhinoView.)

Public Property

Floating

Floating state of RhinoView. if true, then the view will be in a floating frame window. Otherwise the view will be embedded in the main frame.

(Inherited from RhinoView.)

Public Property

Handle

Gets the window handle that this view is bound to.

(Inherited from RhinoView.)

Public Property

InDynamicViewChange

true if the view is being dynamically changed by mouse moves, arrow keys, trackballs, etc.

(Inherited from RhinoView.)

Public Property

MainViewport

A RhinoView contains a “main viewport” that fills the entire view client window. RhinoPageViews may also contain nested child RhinoViewports for implementing detail viewports. The MainViewport will always return this RhinoView’s m_vp.

(Inherited from RhinoView.)

Public Property

Maximized

(Inherited from RhinoView.)

Public Property
Code Example

PageHeight

Height of the page in the document’s PageUnitSystem

Public Property
Code Example

PageIsActive

Returns true if the page is active, rather than any detail view. This occurs when the MainViewport.Id == ActiveViewportID.

Public Property
Code Example

PageName

Same as the MainViewport.Name.

Public Property

PageNumber

Gets or sets the runtime page number and updates the page number for all of the other pages. The first page has a value of 0.

Public Property
Code Example

PageWidth

Width of the page in the document’s PageUnitSystem

Public Property

PaperName

Returns the name of the layout’s media, or paper (e.g. Letter, Legal, A1, etc.), used to determine the page width and page height.

Public Property

PrinterName

Returns the name of the layout’s destination printer.

Public Property

RealtimeDisplayMode

Gets the RealtimeDisplayMode active for this view. null if the view doesn’t have a RealtimeDisplayMode set.

(Inherited from RhinoView.)

Public Property

RuntimeSerialNumber

(Inherited from RhinoView.)

Public Property

ScreenRectangle

Gets the rectangle that represents the client area of the view in screen coordinates.

(Inherited from RhinoView.)

Public Property

Size

Gets or sets the size of the view

(Inherited from RhinoView.)

Public Property

TitleVisible

Visibility of the viewport title window.

(Inherited from RhinoView.)

Methods

Name

Description

Public Method
Code Example

AddDetailView

Creates a detail view object that is displayed on this page and adds it to the document.

Public Method

CaptureToBitmap.

Capture View contents to a bitmap.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(DisplayModeDescription)

Capture View contents to a bitmap using a display mode description to define how drawing is performed.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(DisplayPipelineAttributes)

Captures view contents to a bitmap using display attributes to define how drawing is performed.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(Size)

Capture View contents to a bitmap.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(Size, DisplayModeDescription)

Capture View contents to a bitmap using a display mode description to define how drawing is performed.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(Size, DisplayPipelineAttributes)

Capture View contents to a bitmap using display attributes to define how drawing is performed.

(Inherited from RhinoView.)

Public Method
Code Example

CaptureToBitmap(Boolean, Boolean, Boolean)

Captures the view contents to a bitmap allowing for visibility of grid and axes.

(Inherited from RhinoView.)

Public Method

CaptureToBitmap(Size, Boolean, Boolean, Boolean)

Captures a part of the view contents to a bitmap allowing for visibility of grid and axes.

(Inherited from RhinoView.)

Public Method

ClientToScreen(Point)

(Inherited from RhinoView.)

Public Method

ClientToScreen(Point2d)

(Inherited from RhinoView.)

Public Method

Remove this View from Rhino. DO NOT attempt to use this instance of this class after calling Close.

(Inherited from RhinoView.)

Public Method

CreateShadedPreviewImage

Creates a bitmap preview image of model.

(Inherited from RhinoView.)

Public Method

CreateWireframePreviewImage

Creates a bitmap preview image of model.

(Inherited from RhinoView.)

Public Method

Duplicate

Copies a page view.

Public Method

Equals

(Inherited from RhinoView.)

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

Public Method

GetDetailViews

Gets a list of the detail view objects associated with this layout.

Public Method

GetHashCode

(Inherited from RhinoView.)

Public Method

GetPreviewImage

Creates a preview image of the page.

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Public Method

MouseCaptured

Returns whether or not the mouse is captured in this view.

(Inherited from RhinoView.)

Public Method
Code Example
Redraw

Redraws this view.

(Inherited from RhinoView.)

Public Method

ScreenToClient(Point)

Converts a point in screen coordinates to client coordinates for this view.

(Inherited from RhinoView.)

Public Method

ScreenToClient(Point2d)

(Inherited from RhinoView.)

Public Method
Code Example

SetActiveDetail(Guid)

Sets the active detail.

Public Method

SetActiveDetail(String, Boolean)

Sets the active detail.

Public Method
Code Example

SetPageAsActive

Deactivates the active details and sets the page view as active.

Public Method

ShowToast(String)

Shows a temporary popup message in the lower right corner of the view

(Inherited from RhinoView.)

Public Method

ShowToast(String, Int32)

Shows a temporary popup message in the lower right corner of the view

(Inherited from RhinoView.)

Public Method

ShowToast(String, Int32, PointF)

Shows a temporary popup message in the lower right corner of the view

(Inherited from RhinoView.)

Public Method

SpeedTest

(Inherited from RhinoView.)

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

Events

Name

Description

Public Event
Static Member

PageViewPropertiesChange

Public Event
Static Member

PageViewSpaceChange