Class TransactionsControllerHelper

A helper class for providing the standard controls required for displaying transactions in the various base transaction controllers

Inheritance

object

TransactionsControllerHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.Client.Core.Views.Controllers

Assembly: LemonEdge.ClientCore.dll

Syntax

public static class TransactionsControllerHelper

Properties

AllowCopyCommand

True - Indicates trnasactions should always be able to be copied

Declaration

public static bool AllowCopyCommand { get; }

Property Value

Type	Description
bool

AllowXMLImportExport

False - Indicates transactions can not be exported into an xml format

Declaration

public static bool AllowXMLImportExport { get; }

Property Value

Type	Description
bool

AutoOpenNewItemInTab

True - Indicates transactions should always be able to be opened

Declaration

public static bool AutoOpenNewItemInTab { get; }

Property Value

Type	Description
bool

DefaultSearchColumn

The default column to search on a transaction is the ReportingFXRate

Declaration

public static string DefaultSearchColumn { get; }

Property Value

Type	Description
string

Methods

AlterQuery(QueryableExecuter<ITransaction>, bool)

Filters the standard transaction query to order by ITransaction.TransactionDate and then IHeaderTransactionalEntity.Reference

Declaration

public static QueryableExecuter<ITransaction> AlterQuery(QueryableExecuter<ITransaction> query, bool onlyHeaders)

Parameters

Type	Name	Description
QueryableExecuter<ITransaction>	query	The transaction query to add standard filters to
bool	onlyHeaders	Indicates the query should be filtered to only have transactions where ParentTransactionID is null

Returns

Type	Description
QueryableExecuter<ITransaction>	An updated transaction query for loading the results into a grid

CanEditHeaderBatchRowItem(ITransactionProcessor, ITransaction, ControlDisplayInfoLight)

Declaration

public static bool CanEditHeaderBatchRowItem(ITransactionProcessor processor, ITransaction item, ControlDisplayInfoLight con)

Parameters

Type	Name	Description
ITransactionProcessor	processor
ITransaction	item
ControlDisplayInfoLight	con

Returns

Type	Description
bool

CanEditRowItem(ITransactionProcessor, ITransaction, short, bool, bool)

Declaration

public static bool CanEditRowItem(ITransactionProcessor processor, ITransaction item, short columnDefinitionIndex, bool headerOnly, bool asSet)

Parameters

Type	Name	Description
ITransactionProcessor	processor
ITransaction	item
short	columnDefinitionIndex
bool	headerOnly
bool	asSet

Returns

Type	Description
bool

ColumnNames()

Returns all the standard column controls for viewing any transaction without a ITransactionProcessor

Declaration

public static IEnumerable<ControlDisplayInfoLight> ColumnNames()

Returns

Type	Description
IEnumerable<ControlDisplayInfoLight>	All the standard column controls for viewing any transaction without a ITransactionProcessor

ColumnNames(ITransactionProcessor, ITransaction, bool, bool, bool)

Returns all the standard column controls for viewing transaction from the specified processor

Declaration

public static List<ControlDisplayInfoLight> ColumnNames(ITransactionProcessor processor, ITransaction transaction, bool headerOnly, bool asSet, bool allowEditsThroughCanEditFunc)

Parameters

Type	Name	Description
ITransactionProcessor	processor	An optional processor for the transaction indicating we are viewing an actual transaction set instead of all transactions in the system against an item
ITransaction	transaction
bool	headerOnly	Indicates these are header level (IsHeaderTransaction ) transactions and do not need certain detail column values
bool	asSet
bool	allowEditsThroughCanEditFunc

Returns

Type	Description
List<ControlDisplayInfoLight>	All the standard column controls for viewing transaction from the specified processor

HeaderBatchColumnNames()

Declaration

public static IEnumerable<ControlDisplayInfoLight> HeaderBatchColumnNames()

Returns

Type	Description
IEnumerable<ControlDisplayInfoLight>

UpdateNewItem(ITransaction)

If the transaction has no TransactionDate then it is set to today

Declaration

public static void UpdateNewItem(ITransaction item)

Parameters

Type	Name	Description
ITransaction	item	The new transaction to update default properties with