RhinoPageView

RhinoPageView class

A window that contains a single layout 'page'

Inheritence: Rhino.Display.RhinoViewRhinoPageView
Derived Classes:

Namespace: Rhino.Display
RhinoPageView: references

Properties (27)

ActiveDetail

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

ActiveDetailId

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

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.

ActiveViewport

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.

ActiveViewportID

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

Bounds

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

ClientRectangle

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

DisplayPipeline

Gets the display pipeline used for this view.

Document

EnableDrawing

Gets or sets the 'drawing enabled' flag. By default, drawing is enabled.
There are some rare situations where scripts want to disable drawing for a while.

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.

Handle

Gets the window handle that this view is bound to.

InDynamicViewChange

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

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.

Maximized

PageHeight

Height of the page in the document's PageUnitSystem

PageIsActive

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

PageName

Same as the MainViewport.Name.

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.

PageWidth

Width of the page in the document's PageUnitSystem

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.

PrinterName

Returns the name of the layout's destination printer.

RealtimeDisplayMode

Gets the RealtimeDisplayMode active for this view. None if the view doesn't have a RealtimeDisplayMode set.

RuntimeSerialNumber

ScreenRectangle

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

Size

Gets or sets the size of the view

TitleVisible

Visibility of the viewport title window.

Methods (31)

AddDetailView(string title,Point2d corner0,Point2d corner1, DefinedViewportProjection initialProjection)

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

CaptureToBitmap()

Capture View contents to a bitmap.

CaptureToBitmap(bool grid, bool worldAxes, bool cplaneAxes)

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

CaptureToBitmap(DisplayModeDescription mode)

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

CaptureToBitmap(DisplayPipelineAttributes attributes)

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

CaptureToBitmap(Size size, bool grid, bool worldAxes, bool cplaneAxes)

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

CaptureToBitmap(Size size, DisplayModeDescription mode)

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

CaptureToBitmap(Size size, DisplayPipelineAttributes attributes)

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

CaptureToBitmap(Size size)

Capture View contents to a bitmap.

ClientToScreen(Point2d clientPoint)

ClientToScreen(Point clientPoint)

Close()

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

CreateShadedPreviewImage(string imagePath,Size size, bool ignoreHighlights, bool drawConstructionPlane, bool useGhostedShading)

Creates a bitmap preview image of model.

CreateWireframePreviewImage(string imagePath,Size size, bool ignoreHighlights, bool drawConstructionPlane)

Creates a bitmap preview image of model.

Duplicate(bool duplicatePageGeometry)

Copies a page view.

Equals(object obj)

FromRuntimeSerialNumber(uint serialNumber)

Get a RhinoView from it's unique runtime serial number

GetDetailViews()

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

GetHashCode()

GetPreviewImage(Size size, bool grayScale)

Creates a preview image of the page.

MouseCaptured(bool bIncludeMovement)

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

Redraw()

Redraws this view.

ScreenToClient(Point2d screenPoint)

ScreenToClient(Point screenPoint)

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

SetActiveDetail(string detailName, bool compareCase)

Sets the active detail.

SetActiveDetail(Guid detailId)

Sets the active detail.

SetPageAsActive()

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

ShowToast(string message, int textHeight,PointF location)

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

ShowToast(string message, int textHeight)

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

ShowToast(string message)

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

SpeedTest(int frameCount, bool freezeDrawList, int direction, double angleDeltaRadians)

Events (7)

Create

Destroy

Modified

PageViewPropertiesChange

PageViewSpaceChange

Rename

SetActive

Nothing found