StackedDialogPage

References
public abstract class StackedDialogPage
Base class to inherit from for the addition of stacked dialog pages.

Constructors

StackedDialogPage

#
protected StackedDialogPage(string englishPageTitle)
Protected constructor
Parameters:
englishPageTitle (string)

Properties

Children

#Since v5.0
public List<StackedDialogPage> Children { get; }
List of child (sub) pages of this page

EnglishPageTitle

#Since v5.0
public string EnglishPageTitle { get; }
English string used when scripting this page and a user prefixes a command option with "_"

Handle

#Since v6.0
public nint Handle { get; }
When running on Windows return the window handle for the parent of this page otherwise; return IntPtr.Zero.

HasChildren

#Since v5.0
public bool HasChildren { get; }
Will be true if this page contains sub pages.

LocalPageTitle

#Since v5.0
public virtual string LocalPageTitle { get; }
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

#Since v6.0
public bool Modified { get; set; }
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.

PageControl

#Since v5.0
public virtual object PageControl { get; }
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

#Since v6.0
public virtual Image PageImage { get; }
Optionally override to provide a image to display in the Mac Rhino UI
Value: The page image.

ShowApplyButton

#Since v6.0
public virtual bool ShowApplyButton { get; }
Called when this page is activated
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

#Since v5.0
public virtual bool ShowDefaultsButton { get; }
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

#Since v6.0
public void AddChildPage(StackedDialogPage pageToAdd)
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

#Since v6.0
public void MakeActivePage()
Make this page the active, visible page

OnActivate

#Since v5.0
public virtual bool OnActivate(bool active)
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

OnApply

#Since v5.0
public virtual bool OnApply()
Called when stacked dialog OK button is pressed.
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

#Since v5.0
public virtual void OnCancel()
Called when stacked dialog Cancel button is pressed.

OnCreateParent

#Since v5.0
public virtual void OnCreateParent(nint hwndParent)
Called when the parent window has been created on Windows platforms only.
Parameters:
hwndParent (nint)

OnDefaults

#Since v5.0
public virtual void OnDefaults()
Called when stacked dialog Defaults button is pressed (see ShowDefaultsButton).

OnHelp

#Since v5.0
public virtual void OnHelp()
Called when the parent dialog requests help for this page.

OnSizeParent

#Since v5.0
public virtual void OnSizeParent(int width, int height)
Called when the parent window has been resized
Parameters:
width (int)
height (int)

RemovePage

#Since v6.0
public void RemovePage()
Remove this page from the dialog box

SetActivePageTo

#Since v7.5
public bool SetActivePageTo(string pageName, bool documentPropertiesPage)
Parameters:
pageName (string)
documentPropertiesPage (bool)

SetEnglishPageTitle

#Since v6.0
public void SetEnglishPageTitle(string newPageTile)
Change the title passed to the constructor and, this will cause LocalPageTitle to get called also.
Parameters:
newPageTile (string)