Class GridMenuConfigurationModel

MOdel for storing menu function information of a grid view

Inheritance

System.Object

GridMenuConfigurationModel

Namespace: Simplic.Framework.DBUI

Assembly: Simplic.Framework.DBUI.dll

Syntax

public class GridMenuConfigurationModel : UI.MVC.ViewModelBase

Constructors

| Improve this Doc View Source

GridMenuConfigurationModel()

Create menu model and initialize default values

Declaration

public GridMenuConfigurationModel()

Properties

| Improve this Doc View Source

AddToContextMenu

Defines whether to add the menu entry to the context menu

Declaration

public bool AddToContextMenu { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ClrClass

name of the class which contains the method to execute

Declaration

public string ClrClass { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ClrMethod

Name of a static method in the ClrClass to execute

Declaration

public string ClrMethod { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ClrNamespace

Namespace path to the ClrClass which contains a method to execute

Declaration

public string ClrNamespace { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DisplayIndex

Sort the menu entries ascending by it's order number

Declaration

public int DisplayIndex { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

DisplayName

Display name of the menu entry

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExecuteOnDoubleClick

If set to true, this function will be called after a double click on a row was performed

Declaration

public bool ExecuteOnDoubleClick { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Id

Unique id of the menu function

Declaration

public Guid Id { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

IsCustomMenuEntry

If set to true, this entry will not be deleted when it does not exists any more

Declaration

public bool IsCustomMenuEntry { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsGridColumnBased

Gets or sets whether the menu entry is generated by a specific columns

Declaration

public bool IsGridColumnBased { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsRowBased

Menu functions with IsRowBased = True can only be used, if a row is selected

Declaration

public bool IsRowBased { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeyCode1

First key which must be pressed or hit for executing this menu function

Declaration

public Key KeyCode1 { get; set; }

Property Value

Type	Description
Key

| Improve this Doc View Source

KeyCode2

Second key which must be pressed or hit for executing this menu function

Declaration

public Key KeyCode2 { get; set; }

Property Value

Type	Description
Key

| Improve this Doc View Source

KeyCode3

Third key which must be pressed or hit for executing this menu function

Declaration

public Key KeyCode3 { get; set; }

Property Value

Type	Description
Key

| Improve this Doc View Source

LargeIconGuid

Guid for loading the large icon for the ribbon menu

Declaration

public Guid? LargeIconGuid { get; set; }

Property Value

Type	Description
System.Nullable<Guid>

| Improve this Doc View Source

NamedEvent

Named event for using methhods which must be called in the same instance as the grid is embedded in (class instance)

Declaration

public string NamedEvent { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

NameParameterName

Gets or sets the name of the parameter name

Declaration

public string NameParameterName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ParentMenuEntry

Declaration

public GridMenuConfigurationModel ParentMenuEntry { get; set; }

Property Value

Type	Description
GridMenuConfigurationModel

| Improve this Doc View Source

PrintReport

True if a report should be printed directly

Declaration

public bool PrintReport { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

QuickReportName

Name des Quick-Reports der aufgerufen werden soll

Declaration

public string QuickReportName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ReportViewerType

Report viewer type

Declaration

public OpenReportViewerType ReportViewerType { get; set; }

Property Value

Type	Description
OpenReportViewerType

| Improve this Doc View Source

RibbonIconSize

Size of the ribbon menu entry

Declaration

public ButtonSize RibbonIconSize { get; set; }

Property Value

Type	Description
ButtonSize

| Improve this Doc View Source

RightGuid

Guid controlling user access to the function

Declaration

public Guid RightGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

ScriptClass

Class to use when executing a menu function

Declaration

public string ScriptClass { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ScriptMethod

Method to execute when using a menu function

Declaration

public string ScriptMethod { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ScriptName

Script to execute when using the menu

Declaration

public string ScriptName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SmallIconGuid

Guid for loading the small icon for the ribbon menu and the context menu

Declaration

public Guid? SmallIconGuid { get; set; }

Property Value

Type	Description
System.Nullable<Guid>

| Improve this Doc View Source

ValueParameterName

Gets or sets the name of the value parameter

Declaration

public string ValueParameterName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

VisibilityExpression

Declaration

public string VisibilityExpression { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

GenerateMenuEntries()

Generate a list of menu entries, if IsGridColumnBased is true

Declaration

public IList<GridMenuConfigurationModel> GenerateMenuEntries()

Returns

Type	Description
IList<GridMenuConfigurationModel>	List of menu entries

| Improve this Doc View Source

GetDeepCopy()

Create a deep copy of the current model and generate new id's

Declaration

public GridMenuConfigurationModel GetDeepCopy()

Returns

Type	Description
GridMenuConfigurationModel	Copy of the current obejct/instance

| Improve this Doc View Source

GetDeepCopyNewId()

Create a deep copy of the current model and generate new id's

Declaration

public GridMenuConfigurationModel GetDeepCopyNewId()

Returns

Type	Description
GridMenuConfigurationModel	Copy of the current obejct/instance