Class PluginViewOptions
Options for Plugin Views
Inheritance
Namespace: MediaBrowser.Model.Plugins.UI.Views
Assembly: MediaBrowser.Model.dll
Syntax
public class PluginViewOptionsRemarks
To specify options for plugin views, implement the interface IPluginViewWithOptions in your Page, Dialog or Wizard view.
Properties
CompactViewAppearance
Gets or sets how a Page View should be presented in cases of limited screen space (like TV mode).
Declaration
public CompactViewAppearance CompactViewAppearance { get; set; }Property Value
| Type | Description |
|---|---|
| CompactViewAppearance | The compact view appearance. |
Remarks
Applies to
DialogSize
Gets or sets the preferred dialog size.
Declaration
public DialogSize DialogSize { get; set; }Property Value
| Type | Description |
|---|---|
| DialogSize | The preferred dialog display size. |
Remarks
Please note that in case of TV or mobile display modes, dialogs may always be shown as full-screen.
The default is AutoFit
Applies to
HelpUrl
Gets or sets a URL, pointing to help information for this specific view.
Declaration
public Uri HelpUrl { get; set; }Property Value
| Type | Description |
|---|---|
| System.Uri | The help URL. |
Remarks
Applies to
OKButtonCaption
Declaration
public string OKButtonCaption { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PrimaryDialogAction
Declaration
public DialogAction PrimaryDialogAction { get; set; }Property Value
| Type | Description |
|---|---|
| DialogAction |
QueryCloseAction
Gets or sets the action to be taken when the plugin view is exited.
Declaration
public QueryCloseAction QueryCloseAction { get; set; }Property Value
| Type | Description |
|---|---|
| QueryCloseAction | The query close action. |
Remarks
Use this to specify what should happen when the user exits a view by navigating back, pressing cancel or mouse-clicking or tapping outside of a dialog.
The default is None
Applies to
WizardHidingBehavior
Gets or sets the action to be taken when leaving a Wizard View.
Declaration
public WizardHidingBehavior WizardHidingBehavior { get; set; }Property Value
| Type | Description |
|---|---|
| WizardHidingBehavior | The wizard hiding behavior. |
Remarks
Use this to specify what should happen when the user exits a wizard view by navigating away, mouse-clicking or tapping outside of the wizard.
Please note that it can make sense to use different values at different stages of a wizard progress. For example, the initial wizard page should always be set to AutoCancel as there is not state that would need to be retained.
The default is AutoCancel
Applies to