public abstract class OptionsDialogPage : StackedDialogPage

Constructors

OptionsDialogPage

#
protected OptionsDialogPage(
englishPageTitle
)

Properties

Children

List of child (sub) pages of this page
public List<StackedDialogPage> Children { get; }
inherited fromStackedDialogPage

EnglishPageTitle

English string used when scripting this page and a user prefixes a command option with "_"
public string EnglishPageTitle { get; }
inherited fromStackedDialogPage

Handle

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

HasChildren

Will be true if this page contains sub pages.
public bool HasChildren { get; }
inherited fromStackedDialogPage

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.
public virtual string LocalPageTitle { get; }
inherited fromStackedDialogPage

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.
public bool Modified { get; set; }
inherited fromStackedDialogPage

OptionsPageType

#Since v8.0
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.
public OptionsDialogPage.PageType OptionsPageType { get; }

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.
public virtual object PageControl { get; }
inherited fromStackedDialogPage

PageImage

Optionally override to provide a image to display in the Mac Rhino UI
public virtual Image PageImage { get; }
inherited fromStackedDialogPage
The page image.

ShowApplyButton

Called when this page is activated
public virtual bool ShowApplyButton { get; }
inherited fromStackedDialogPage
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.
public virtual bool ShowDefaultsButton { get; }
inherited fromStackedDialogPage
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.
public void AddChildPage()
inherited fromStackedDialogPage

MakeActivePage

Make this page the active, visible page
public void MakeActivePage()
inherited fromStackedDialogPage

OnActivate

Called when this page is activated/deactivated.
public virtual bool OnActivate(
active
If true then this page is on top otherwise it is about to be hidden.
)
inherited fromStackedDialogPage
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

Called when stacked dialog OK button is pressed.
public virtual bool OnApply()
inherited fromStackedDialogPage
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

Called when stacked dialog Cancel button is pressed.
public virtual void OnCancel()
inherited fromStackedDialogPage

OnCreateParent

Called when the parent window has been created on Windows platforms only.
public virtual void OnCreateParent(
nint
hwndParent
)
inherited fromStackedDialogPage

OnDefaults

Called when stacked dialog Defaults button is pressed (see ShowDefaultsButton).
public virtual void OnDefaults()
inherited fromStackedDialogPage

OnHelp

Called when the parent dialog requests help for this page.
public virtual void OnHelp()
inherited fromStackedDialogPage

OnSizeParent

Called when the parent window has been resized
public virtual void OnSizeParent(
width,
height
)
inherited fromStackedDialogPage

RemovePage

Remove this page from the dialog box
public void RemovePage()
inherited fromStackedDialogPage

RunScript

#Since v5.0
public virtual Result RunScript(
doc,
mode
)

SetActivePageTo

public bool SetActivePageTo(
pageName,
documentPropertiesPage
)
inherited fromStackedDialogPage

SetEnglishPageTitle

Change the title passed to the constructor and, this will cause LocalPageTitle to get called also.
public void SetEnglishPageTitle(
newPageTile
)
inherited fromStackedDialogPage