Class NavigationOptions

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the navigation options.

public class NavigationOptions

Inheritance

object

NavigationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NavigationOptions(string)

Initializes a new instance of the NavigationOptions class.

public NavigationOptions(string uiViewName)

Parameters

uiViewName string

UI view name.

Properties

Callback

Gets or sets the callback function called when the UI view is closed.

public Action<NavigationResult> Callback { get; set; }

Property Value

Action<NavigationResult>

Closeable

Gets or sets a value indicating whether the view is closeable by the user.

public bool? Closeable { get; set; }

Property Value

bool?

ContainerId

Gets or sets the container identifier.

public string? ContainerId { get; set; }

Property Value

string

Datasource

Gets or sets the datasource.

public IDatasource<IUIView>? Datasource { get; set; }

Property Value

IDatasource<IUIView>

FrameId

Gets or sets the frame identifier.

public string? FrameId { get; set; }

Property Value

string

Icon

Gets or sets the icon.

public string Icon { get; set; }

Property Value

string

Parameters

Gets the parameters.

public NavigationParameters Parameters { get; }

Property Value

NavigationParameters

PopupPosition

Gets or sets the popup position.

public PopupPosition PopupPosition { get; set; }

Property Value

PopupPosition

PopupSize

Gets or sets the popup size.

public PopupSize PopupSize { get; set; }

Property Value

PopupSize

Position

Gets or sets the position at the opening.

public int? Position { get; set; }

Property Value

int?

Target

Gets or sets the target.

public NavigationTarget Target { get; set; }

Property Value

NavigationTarget

Title

Gets or sets the title.

public string? Title { get; set; }

Property Value

string

UIViewName

Gets or sets the UI view name.

public string UIViewName { get; set; }

Property Value

string

Methods

OnTarget(NavigationTarget)

Sets the target.

public NavigationOptions OnTarget(NavigationTarget target)

Parameters

target NavigationTarget

Target.

Returns

NavigationOptions

The navigation options.

WithCallback<TValue>(Action<NavigationResult<TValue>>)

Sets the callback function called when the UI view is closed.

public NavigationOptions WithCallback<TValue>(Action<NavigationResult<TValue>> callback)

Parameters

callback Action<NavigationResult<TValue>>

The callback action.

Returns

NavigationOptions

The navigation options.

Type Parameters

TValue

Type of the result value.

WithCloseable(bool?)

Sets the value indicating whether the view is closeable by the user.

public NavigationOptions WithCloseable(bool? closeable)

Parameters

closeable bool?

Value indicating whether the view is closeable by the user.

Returns

NavigationOptions

The navigation options.

WithContainerId(string?)

Sets the container identifier.

public NavigationOptions WithContainerId(string? containerId)

Parameters

containerId string

Container identifier.

Returns

NavigationOptions

The navigation options.

WithCreationMode(bool?)

Adds the creation mode parameter.

public NavigationOptions WithCreationMode(bool? creationMode)

Parameters

creationMode bool?

Creation mode.

Returns

NavigationOptions

The navigation options.

WithDataSharing<TUIView>(IDatasource<TUIView>?, int?)

Sets the data source to share with the view to open and the position at the opening.

public NavigationOptions WithDataSharing<TUIView>(IDatasource<TUIView>? datasource, int? position) where TUIView : class, IUIView

Parameters

datasource IDatasource<TUIView>

Shared datasource.

position int?

Position at the opening.

Returns

NavigationOptions

The navigation options.

Type Parameters

TUIView

UI view type.

WithFrameId(string?)

Sets the tab identifier.

public NavigationOptions WithFrameId(string? frameId)

Parameters

frameId string

Frame identifier.

Returns

NavigationOptions

The navigation options.

WithIcon(string?)

Sets the icon.

public NavigationOptions WithIcon(string? icon)

Parameters

icon string

Icon.

Returns

NavigationOptions

The navigation options.

WithId(Dictionary<string, object>?)

Adds the identifier parameter.

public NavigationOptions WithId(Dictionary<string, object>? id)

Parameters

id Dictionary<string, object>

Identifier.

Returns

NavigationOptions

The navigation options.

WithNewParameters(NavigationParameters)

Sets the new parameters.

public NavigationOptions WithNewParameters(NavigationParameters parameters)

Parameters

parameters NavigationParameters

Parameters.

Returns

NavigationOptions

The navigation options.

WithPageNumber(int?)

Adds the page number parameter.

public NavigationOptions WithPageNumber(int? pageNumber)

Parameters

pageNumber int?

Page number.

Returns

NavigationOptions

The navigation options.

WithParameter(string, object)

Adds a parameter.

public NavigationOptions WithParameter(string key, object value)

Parameters

key string

Parameter key.

value object

Parameter value.

Returns

NavigationOptions

The navigation options.

WithPopupMaximizable(bool)

Sets the popup maximizable.

public NavigationOptions WithPopupMaximizable(bool popupMaximizable)

Parameters

popupMaximizable bool

The popup maximizable.

Returns

NavigationOptions

The navigation options.

WithPopupPosition(PopupPosition)

Sets the popup position.

public NavigationOptions WithPopupPosition(PopupPosition popupPosition)

Parameters

popupPosition PopupPosition

The popup position.

Returns

NavigationOptions

The navigation options.

WithPopupSize(PopupSize)

Sets the popup size.

public NavigationOptions WithPopupSize(PopupSize popupSize)

Parameters

popupSize PopupSize

The popup size.

Returns

NavigationOptions

The navigation options.

WithRecordsByPage(int?)

Adds the records by page parameter.

public NavigationOptions WithRecordsByPage(int? recordsByPage)

Parameters

recordsByPage int?

Records by page.

Returns

NavigationOptions

The navigation options.

WithTitle(string?)

Sets the title.

public NavigationOptions WithTitle(string? title)

Parameters

title string

Title.

Returns

NavigationOptions

The navigation options.