Class GridMenuHandler

Handle all functions which are connected with a grid and all it's profiles

Inheritance

System.Object

GridMenuHandler

Implements

System.IDisposable

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.Framework.DBUI

Assembly: Simplic.Framework.DBUI.dll

Syntax

public class GridMenuHandler : IDisposable

Constructors

| Improve this Doc View Source

GridMenuHandler(IntegratedGridView)

Create simple menu handler

Declaration

public GridMenuHandler(IntegratedGridView gridView)

Parameters

Type	Name	Description
IntegratedGridView	gridView	Grid view which is connected with the menu handler

Properties

| Improve this Doc View Source

GridView

Connected grid view as menu handler base

Declaration

public IntegratedGridView GridView { get; }

Property Value

Type	Description
IntegratedGridView

| Improve this Doc View Source

KeyboardController

Get or set the current keyboard controller. This can only be set once

Declaration

public KeyboardController KeyboardController { get; set; }

Property Value

Type	Description
KeyboardController

| Improve this Doc View Source

NamedEventList

List of all named events which are available

Declaration

public IDictionary<string, GridMenuHandler.OnCalledNamedEvent> NamedEventList { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, GridMenuHandler.OnCalledNamedEvent>

| Improve this Doc View Source

ProgrammaticallyAddedFunctions

List of all programatically added functions

Declaration

public IList<GridMenuFunction> ProgrammaticallyAddedFunctions { get; }

Property Value

Type	Description
System.Collections.Generic.IList<GridMenuFunction>

| Improve this Doc View Source

RibbonContextController

Set controller and refresh tab content

Declaration

public RibbonContextController RibbonContextController { get; set; }

Property Value

Type	Description
RibbonContextController

Methods

| Improve this Doc View Source

AddEvent(String, GridMenuHandler.OnCalledNamedEvent)

Add event for inline calls

Declaration

public void AddEvent(string name, GridMenuHandler.OnCalledNamedEvent namedEventDelegate)

Parameters

Type	Name	Description
System.String	name	Name of the event
GridMenuHandler.OnCalledNamedEvent	namedEventDelegate	Method which will be executed

| Improve this Doc View Source

AddGridRowFunction(String, String, String, String, String, Boolean, ButtonSize, Nullable<Guid>, Nullable<Guid>, Key[])

Programatically add a menu function

Declaration

public GridMenuFunction AddGridRowFunction(string displayName, string namedEvent, string scriptName, string scriptClass, string scriptMethod, bool isRowBased, ButtonSize ribbonIconSize = null, Guid? smallIconGuid = null, Guid? largeIconGuid = null, Key[] keys = null)

Parameters

Type	Name	Description
System.String	displayName	Display text of the function
System.String	namedEvent	Named event name which can be used over AddEvent
System.String	scriptName	Script name to execute
System.String	scriptClass	Script class to execute
System.String	scriptMethod	Script method to execute
System.Boolean	isRowBased	Defines, whether the menu entry is row based
ButtonSize	ribbonIconSize	Define the size if the ribbon button
System.Nullable<System.Guid>	smallIconGuid	Id of the image (large). Will be loaded from the database
System.Nullable<System.Guid>	largeIconGuid	Id of the image (large). Will be loaded from the database
System.Windows.Input.Key[]	keys	Optional keys

Returns

Type	Description
GridMenuFunction	Instance of a menu function

| Improve this Doc View Source

CopyToClipboard(GridFunctionParameter)

Copy to clipboard

Declaration

public static GridInvokeMethodResult CopyToClipboard(GridFunctionParameter parameter)

Parameters

Type	Name	Description
GridFunctionParameter	parameter

Returns

Type	Description
GridInvokeMethodResult

| Improve this Doc View Source

Dispose()

Declaration

public void Dispose()

| Improve this Doc View Source

LoadConfiguration(IList<GridMenuConfigurationModel>)

Load list of menu function configurations

Declaration

public void LoadConfiguration(IList<GridMenuConfigurationModel> configurations)

Parameters

Type	Name	Description
System.Collections.Generic.IList<GridMenuConfigurationModel>	configurations	List of configurations

| Improve this Doc View Source

RefreshGrid(GridFunctionParameter)

Refresh grid

Declaration

public static GridInvokeMethodResult RefreshGrid(GridFunctionParameter parameter)

Parameters

Type	Name	Description
GridFunctionParameter	parameter

Returns

Type	Description
GridInvokeMethodResult

| Improve this Doc View Source

RefreshMenu(Boolean, Boolean)

Refresh the menu and applay all settings

Declaration

public void RefreshMenu(bool refreshRibbonMenu = true, bool refreshContextMenu = true)

Parameters

Type	Name	Description
System.Boolean	refreshRibbonMenu
System.Boolean	refreshContextMenu

Events

| Improve this Doc View Source

RequestScriptParameter

Request all dynamic parameter for script based execution

Declaration

public event GridMenuHandler.RequestScriptParameterHandler RequestScriptParameter

Event Type

Type	Description
GridMenuHandler.RequestScriptParameterHandler

Implements

System.IDisposable