Constructors
Properties
EnglishPageTitle
English string used when scripting this page and a user prefixes a command option with "_"
Handle
public nint Handle { get; }
When running on Windows return the window handle for the parent of this page otherwise; return IntPtr.Zero.
LocalPageTitle
Localized page title that will appear on a tab or other page navigation control. This is also uses as a command line option when scripting this page.
Modified
Check to see if the page has been marked as modified or not. Marking the page as modified will cause the Apply button to get enabled if this is currently the visible page and the page includes the Apply button.
17 March 2021 John Morse For internal use in determining the page type. RhinoMac uses this to ensure pages are sized properly when hosting them.
PageControl
Return the control that represents this page. Rhino Windows supports classes that implement the IWin32Windows interface or are derived from some form of System.Windows.FrameworkElement or Eto.Forms.Control. Mac Rhino supports controls that are derived from NSview or Eto.Forms.Control.
PageImage
Optionally override to provide a image to display in the Mac Rhino UI
Value: The page image.
Returns: true : if the page wants the "Apply" button to appear. false : if the page does not want the "Apply" button to appear. Default returns false Note: If true is returned OnApply will get called when the button is clicked.
ShowDefaultsButton
Called when this page is activated.
Returns: true : if the page wants the "Defaults" button to appear. false : if the page does not want the "Defaults" button to appear. Default returns false Note: returning false implies that OnDefaults() method will never get called.
Methods
AddChildPage
Currently only supported on Windows. Call this method to add a child page to a page after the parent dialog has been created.
Parameters:
| pageToAdd (StackedDialogPage) |
MakeActivePage
public void MakeActivePage()
Make this page the active, visible page
OnActivate
Called when this page is activated/deactivated.
Parameters:
| active (bool) | If true then this page is on top otherwise it is about to be hidden. |
Returns: If true then the page is hidden and the requested page is not activated otherwise will not allow you to change the current page. Default returns true
Returns: If return value is true then the dialog will be closed. A return of false means there was an error and dialog remains open so page can be properly updated.
OnCancel
public virtual void OnCancel()
Called when stacked dialog Cancel button is pressed.
OnCreateParent
public virtual void OnCreateParent(nint hwndParent)
Called when the parent window has been created on Windows platforms only.
Parameters:
| hwndParent (nint) |
OnDefaults
public virtual void OnDefaults()
Called when stacked dialog Defaults button is pressed (see ShowDefaultsButton).
OnHelp
public virtual void OnHelp()
Called when the parent dialog requests help for this page.
OnSizeParent
Called when the parent window has been resized
RemovePage
public void RemovePage()
Remove this page from the dialog box
SetEnglishPageTitle
Change the title passed to the constructor and, this will cause LocalPageTitle to get called also.
Parameters:
| newPageTile (string) |