Class GridInvokeMethodResult

Result of an grid view function call

Inheritance

System.Object

GridInvokeMethodResult

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 GridInvokeMethodResult

Properties

| Improve this Doc View Source

RefreshGrid

Gets or sets whether to refresh the underlying grid

Declaration

public bool RefreshGrid { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Tasks

Gets or sets a list of tasks to complete async

Declaration

public IList<Task> Tasks { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.Threading.Tasks.Task>

| Improve this Doc View Source

Window

Gets or sets an instance of a ribbon window

Declaration

public DefaultRibbonWindow Window { get; set; }

Property Value

Type	Description
DefaultRibbonWindow

Methods

| Improve this Doc View Source

NoGridRefresh()

Gets an inoke result for not refreshing the grid immediately

Declaration

public static GridInvokeMethodResult NoGridRefresh()

Returns

Type	Description
GridInvokeMethodResult	GridInvokeMethodResult/RefreshGrid = false

| Improve this Doc View Source

ProcessAsync(Boolean, IList<Task>)

Gets an invoke result that requries async handling

Declaration

public static GridInvokeMethodResult ProcessAsync(bool refreshGrid, IList<Task> tasks)

Parameters

Type	Name	Description
System.Boolean	refreshGrid	If set to true, the grid will be refreshed after task handling
System.Collections.Generic.IList<System.Threading.Tasks.Task>	tasks	List of tasks to process

Returns

Type	Description
GridInvokeMethodResult	Grid invoke result

| Improve this Doc View Source

RefreshGridImmediately()

Gets an invoke result for refreshing the grid

Declaration

public static GridInvokeMethodResult RefreshGridImmediately()

Returns

Type	Description
GridInvokeMethodResult	GridInvokeMethodResult/RefreshGrid = true

| Improve this Doc View Source

SetIsIndeterminate(String)

Set progress as indeterminate

Declaration

public void SetIsIndeterminate(string text)

Parameters

Type	Name	Description
System.String	text	Display text

| Improve this Doc View Source

SetProgress(Int32, Int32, String)

Set async processing status

Declaration

public void SetProgress(int objectsToProcess, int processedObjects, string text)

Parameters

Type	Name	Description
System.Int32	objectsToProcess	Amount of objects to process
System.Int32	processedObjects	Process objects
System.String	text	Custom display text

| Improve this Doc View Source

WindowClosedHint(DefaultRibbonWindow)

Gets an invoke result that shows a hint in the grid view if the window was closed

Declaration

public static GridInvokeMethodResult WindowClosedHint(DefaultRibbonWindow window)

Parameters

Type	Name	Description
DefaultRibbonWindow	window	Window closed

Returns

Type	Description
GridInvokeMethodResult	GridInvokeMethodResult/window instance passed