ObjectPropertiesPage

ObjectPropertiesPage class

Base class used to add object property user interface panels

Namespace: Rhino.UI
ObjectPropertiesPage: references

Constructors (1)

ObjectPropertiesPage()

Initializes a new instance of the ObjectPropertiesPage class

Properties (11)

AllObjectsMustBeSupported

Returns False which only requires a single item of SupportedTypes to be selected. Override if you wish to change the above behavior.

EnglishPageTitle

English string used to describe this page

Icon

(OBSOLETE - Override PageIcon instead) Icon to display in the object properties tab control

Index

The page navigation control adds buttons in the order the pages are processed, override this method and return a sort index to move the button to the beginning of the list. By default this returns -1 which puts the button at the end of the list.

LocalPageTitle

Localized page description string, returns the EnglishPageTitle by default.

PageControl

The control that represents this page. Rhino Windows supports classes that implement the IWin32Windows interface, are derived from System.Windows.FrameworkElement or Eto.Forms.Control. Mac Rhino supports controls that are derived from NSview or Eto.Forms.Control.

PageIconEmbeddedResourceString

Resource string for a embedded icon resource in the assembly containing the page instance. If this returns a valid resource and Rhino can load the icon the loaded icon will get used directly otherwise; the PageIcon method will get called.

PageType

Override this and return the page you want to replace a specific object properties page.

SelectedObjects

Return a list of Rhino objects to be processed by this object properties page

SupportedTypes

Override to specify which objects this page supports

SupportsSubObjects

If your object properties page supports sub-object selection, you should override this method and return true. This is ignored for view pages. The default implementation returns false.

Methods (16)

AnySelectedObject()

Return True if any of the selected objects match the given type

AnySelectedObject(Boolean allMustMatch)

Return True if any of the selected objects match the given type

GetSelectedObjects()

Get selected objects of a given type

GetSelectedObjects(ObjectType filter)

Get selected objects that match a given filter

InitializeControls(RhinoObject rhObj)

Called on the active page after the selected objects list has changed to notify the page to initialize its content to reflect the new object list.

ModifyPage(Action<ObjectPropertiesPageEventArgs> callbackAction)

Call this method when the page is ready to modify the selected objects list. Rhino will suspend UpdatePageNotfictaion, call the passed action then restore UpdatePageNotfictaion.

OnActivate(Boolean active)

Called when this page is activated/deactivated.

OnCreateParent(IntPtr hwndParent)

Called when the parent container is initially created.

OnHelp()

Called when the F1 key or help button is pressed, override to display plug-in specific help for this page.

OnSizeParent(Int32 width,Int32 height)

Called when the parent containers client rectangle size has changed and the PageControl has been resized.

PageIcon(Size sizeInPixels)

Icon to display in the object properties tab control. Will not get called if PageIconEmbeddedResourceString is overridden and provides a string for a successfully loaded icon resource.

RunScript(ObjectPropertiesPageEventArgs e)

This method is called when scripting the Rhino Properties command and choosing this page.

RunScript(RhinoDoc doc, RhinoObject[] objectList)

This method is called when scripting the Rhino Properties command and choosing this page.

ShouldDisplay(ObjectPropertiesPageEventArgs e)

Called when the selected objects list changes, return True if the object list contains one or more object the page can modify.

ShouldDisplay(RhinoObject rhObj)

Called when the selected objects list changes, return True if the object list contains one or more object the page can modify.

UpdatePage(ObjectPropertiesPageEventArgs e)

Called on the active page after the selected objects list has changed to notify the page to initialize its content to reflect the new object list.

Nothing found