Click or drag to resize

RhinoPageView Class

A window that contains a single layout 'page'
Inheritance Hierarchy

Namespace:  Rhino.Display
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class RhinoPageView : RhinoView

The RhinoPageView type exposes the following members.

Properties
  NameDescription
Public propertyActiveDetail
Returns the active detail object. If no detail is active, or if the page is active, then null is returned.
Public propertyActiveDetailId
Returns the id of the active detail. If no detail is active, or if the page is active, then Guid.Empty is returned.
Public propertyActiveViewport
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 RhinoViewActiveViewport.)
Public propertyActiveViewportID
Returns viewport ID for the active viewport. Faster than ActiveViewport function when working with page views.
(Inherited from RhinoView.)
Public propertyBounds
Gets the size and location of the view including its non-client elements, in pixels, relative to the parent control.
(Inherited from RhinoView.)
Public propertyClientRectangle
Gets the rectangle that represents the client area of the view.
(Inherited from RhinoView.)
Public propertyDisplayPipeline
Gets the display pipeline used for this view.
(Inherited from RhinoView.)
Public propertyDocument (Inherited from RhinoView.)
Public propertyFloating
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 propertyHandle
Gets the window handle that this view is bound to.
(Inherited from RhinoView.)
Public propertyMainViewport
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 propertyMaximized (Inherited from RhinoView.)
Public propertyCode examplePageHeight
Height of the page in the document's PageUnitSystem
Public propertyCode examplePageIsActive
Returns true if the page is active, rather than any detail view. This occurs when the MainViewport.Id == ActiveViewportID.
Public propertyCode examplePageName
Same as the MainViewport.Name.
Public propertyPageNumber
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 propertyCode examplePageWidth
Width of the page in the document's PageUnitSystem
Public propertyPaperName
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 propertyPrinterName
Returns the name of the layout's destination printer.
Public propertyRealtimeDisplayMode
Gets the RealtimeDisplayMode active for this view. null if the view doesn't have a RealtimeDisplayMode set.
(Inherited from RhinoView.)
Public propertyRuntimeSerialNumber (Inherited from RhinoView.)
Public propertyScreenRectangle
Gets the rectangle that represents the client area of the view in screen coordinates.
(Inherited from RhinoView.)
Public propertySize
Gets or sets the size of the view
(Inherited from RhinoView.)
Public propertyTitleVisible
Visibility of the viewport title window.
(Inherited from RhinoView.)
Top
Methods
  NameDescription
Public methodCode exampleAddDetailView
Creates a detail view object that is displayed on this page and adds it to the document.
Public methodCaptureToBitmap
Capture View contents to a bitmap.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(Size)
Capture View contents to a bitmap.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(DisplayModeDescription)
Capture View contents to a bitmap using a display mode description to define how drawing is performed.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(DisplayPipelineAttributes)
Captures view contents to a bitmap using display attributes to define how drawing is performed.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(Size, DisplayModeDescription)
Capture View contents to a bitmap using a display mode description to define how drawing is performed.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(Size, DisplayPipelineAttributes)
Capture View contents to a bitmap using display attributes to define how drawing is performed.
(Inherited from RhinoView.)
Public methodCode exampleCaptureToBitmap(Boolean, Boolean, Boolean)
Captures the view contents to a bitmap allowing for visibility of grid and axes.
(Inherited from RhinoView.)
Public methodCaptureToBitmap(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 methodClientToScreen(Point) (Inherited from RhinoView.)
Public methodClientToScreen(Point2d) (Inherited from RhinoView.)
Public methodClose
Remove this View from Rhino. DO NOT attempt to use this instance of this class after calling Close.
(Inherited from RhinoView.)
Public methodCreateShadedPreviewImage
Creates a bitmap preview image of model.
(Inherited from RhinoView.)
Public methodCreateWireframePreviewImage
Creates a bitmap preview image of model.
(Inherited from RhinoView.)
Public methodDuplicate
Copies a page view.
Public methodEquals (Inherited from RhinoView.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetDetailViews
Gets a list of the detail view objects associated with this layout.
Public methodGetHashCode (Inherited from RhinoView.)
Public methodGetPreviewImage
Creates a preview image of the page.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMouseCaptured
Returns whether or not the mouse is captured in this view.
(Inherited from RhinoView.)
Public methodCode exampleRedraw
Redraws this view.
(Inherited from RhinoView.)
Public methodScreenToClient(Point)
Converts a point in screen coordinates to client coordinates for this view.
(Inherited from RhinoView.)
Public methodScreenToClient(Point2d) (Inherited from RhinoView.)
Public methodCode exampleSetActiveDetail(Guid)
Sets the active detail.
Public methodSetActiveDetail(String, Boolean)
Sets the active detail.
Public methodCode exampleSetPageAsActive
Deactivates the active details and sets the page view as active.
Public methodSpeedTest (Inherited from RhinoView.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventStatic memberPageViewSpaceChange
Top
See Also