BCE.AutoCount.UDF namespace
Posted on July 1, 2016 | By Mohd Imran
Contents
- 1 Introduction
- 2 Classes
- 2.1 BaseUDF class
- 2.2 BooleanUDF class
- 2.3 DateType enum
- 2.4 DateUDF class
- 2.5 DecimalUDF class
- 2.6 Field class
- 2.7 ImageLinkUDF class
- 2.8 IntegerUDF class
- 2.9 Layout class
- 2.10 LayoutItem class
- 2.11 LayoutPage class
- 2.12 List class
- 2.13 MaskType enum
- 2.14 MemoUDF class
- 2.15 RichTextUDF class
- 2.16 SupportedUDF class
- 2.17 SystemType enum
- 2.18 SystemUDF class
- 2.19 TextUDF class
- 2.20 UCSystemUDF class
- 2.21 UDFColumn class
- 2.22 UDFDateSubType enum
- 2.23 UDFLayout class
- 2.24 UDFList class
- 2.25 UDFTable class
- 2.26 UDFType enum
- 2.27 UDFUtil class
- 3 UDF Supported Table
- 4 Delegates
Introduction
This post will discuss the BCE.AutoCount.UDF namespace available in AutoCount Accounting. It will cover the methods and properties of the classes used in creating and maintaining the UDF and UDL required by normal users.
Classes
BaseUDF class
The BaseUDF class is an abstract class that is inherited by all of the UDF type class.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
DefaultValue | string | Returns or Set the default value of the UDF |
Required | boolean | Returns or Set the Required flag |
Unique | boolean | Returns or Set the Unique flag |
BooleanUDF class
This class provides properties for the boolean field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
DefaultValue | object | Returns or Set the default value of the BooleanUDF |
DateType enum
The enum for the date types.
Enum Name |
---|
Date |
DateTime |
Time |
DateUDF class
This class provides properties for the date field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
DateType | BCE.AutoCount.UDF.DateType | Returns or Set the date type of the DateUDF |
DefaultValue | object | Returns or Set the default value of the BooleanUDF |
DecimalUDF class
This class provides properties for the decimal field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
DateType | BCE.AutoCount.UDF.DateType | Returns or Set the date type of the DateUDF |
DefaultValue | object | Returns or Set the default value of the BooleanUDF |
Formula | string | |
Precision | int | Returns or Set the Precision (number of digits in a number) of the Decimal UDF |
Scale | int | Returns or Set the Scale (number of digits to the right of the decimal point in a number) of the Decimal UDF |
Field class
This class is use to hold the user defined field record.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | Field() | |
Properties: | ||
Name | Type | Description |
BooleanProperties | BCE.AutoCount.UDF.BooleanUDF | Access the BooleanUDF properties (for UDFType Boolean) |
Caption | string | Return or Set the Caption of the UDF |
DateProperties | BCE.AutoCount.UDF.DateUDF | Access the DateUDF properties (for UDFType Date) |
DecimalProperties | BCE.AutoCount.UDF.DecimalUDF | Access the DecimalUDF properties (for UDFType Decimal) |
ImageLinkProperties | BCE.AutoCount.UDF.ImageLinkUDF | Access the ImageLinkUDF properties (for UDFType ImageLink) |
IntegerProperties | BCE.AutoCount.UDF.IntegerUDF | Access the IntegerUDF properties (for UDFType Integer) |
MemoProperties | BCE.AutoCount.UDF.MemoUDF | Access the MemoUDF properties (for UDFType Memo) |
Name | string | |
Properties | BCE.AutoCount.UDF.BaseUDF | Access the BaseUDF properties |
SystemProperties | BCE.AutoCount.UDF.SystemUDF | Access the SystemUDF properties (for UDFType System) |
TextProperties | BCE.AutoCount.UDF.TextUDF | Access the TextUDF properties (for UDFType Text) |
Type | BCE.AutoCount.UDF.UDFType | Return or Set the Type of the UDF |
ImageLinkUDF class
This class provides properties for the image link field. The ImageLinkUDF class inherits the properties available in the BaseUDF class.
IntegerUDF class
This class provides properties for the integer field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
DefaultValue | object | Returns or Set the default value of the IntegerUDF |
Layout class
Namespace: | BCE.AutoCount.UDF |
Constructor: | Layout() |
LayoutItem class
Namespace: | BCE.AutoCount.UDF |
Constructor: | LayoutItem() |
LayoutPage class
Namespace: | BCE.AutoCount.UDF |
Constructor: | LayoutPage() |
List class
This class is use to store the data of a list.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | List() | |
Properties: | ||
Name | Type | Description |
Name | string | Return or Set the list name |
Methods: | ||
Name | Parameter | Description |
GetItems() | Returns an array of string containing the list items. | |
SetItems(string[] items) | items: List items | Sets the list items |
MaskType enum
The enum for the edit mask types.
Enum Name |
---|
None |
Regex |
Simple |
MemoUDF class
This class provides properties for the memo field. The MemoUDF class inherits the properties available in the BaseUDF class.
RichTextUDF class
This class provides properties for the rich text field. The RichTextUDF class inherits the properties available in the BaseUDF class.
SupportedUDF class
This class provides methods to allow new data tables be UDF supported. All the methods in this class is static hence to use it, you do not need to initialize the class
Namespace: | BCE.AutoCount.UDF | |
Constructor: | SupportedUDF() | |
Properties: | ||
Name | Type | Description |
SupportedUDFTableCount | int | Returns the number of UDF supported table |
Methods: | ||
Name | Parameter | Description |
AddSupportedUDFTable(string tableName, string category, string description, bool isPos) | tableName: the table name category: the category to show the table under (in UDF window) description: the description of the udf isPos: is the table under POS system | Adds the specified table as a UDF supported table |
AddSupportedUDFTable(string tableName, string category, string description) | tableName: the table name category: the category to show the table under (in UDF window) description: the description of the udf | Adds the specified table as a UDF supported table |
GetSupportedUDFTableInfo(int index, out string tableName, out string category, out string description, out bool isPOS) | index: index of the table tableName: returns the table name category: returns the category description: returns the description isPos: returns the flag if the table is under the POS system | Get the UDF Supported Table info using the index of the table |
IsPOSTableInstalled(BCE.Data.DBSetting dbSetting) | dbSetting: a DBSetting object | Checks if the database has POS table installed |
SystemType enum
The enum for the system field types.
Enum Name |
---|
Account |
AreaCode |
CNType |
Creditor |
CreditorType |
CreditTerm |
Currency |
Debtor |
DebtorType |
Department |
DNType |
ItemCode |
ItemGroup |
ItemType |
Location |
PaymentMethod |
PriceCategory |
Project |
PurchaseAgent |
SalesAgent |
ShippingMethod |
SystemUDF class
This class provides properties for the system field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
CustomDataType | string | Returns or sets the data type |
ShowLabel | bool | Returns or sets whether to show the description label. |
TextUDF class
This class provides properties for the text field.
Namespace: | BCE.AutoCount.UDF | |
Properties: | ||
Name | Type | Description |
InputMask | string | Returns or sets the input mask |
LimitToList | bool | Returns or sets whether to limit the input to list values |
ListName | string | Returns or sets the list name. An empty string means no list to be used |
MaskType | BCE.AutoCount.UDF.MaskType | Returns or sets the input mask type |
Size | int | Returns or sets the field size |
UCSystemUDF class
Namespace: | BCE.AutoCount.UDF | |
Constructor: | UCSystemUDF() | |
Properties: | ||
Name | Type | Description |
DBSetting | BCE.Data.DBSetting | Returns or sets the database setting |
DescriptionColumn | string | Returns or sets the description column |
IDColumn | string | Returns or sets the ID column |
LookUpEdit | DevExpress.XtraEditors.LookupEdit | Returns the lookup editor |
TableName | string | Returns or sets the table name. |
UDFColumn class
This class is use to store the field name and caption of a UDF column.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | UDFColumn(string actualFieldName string caption BCE.AutoCount.UDF.UDFDateSubType dateSubType) | |
UDFColumn(string actualFieldName string caption BCE.AutoCount.UDF.UDFType type) | ||
UDFColumn(string actualFieldName string caption) | ||
Properties: | ||
Name | Type | Description |
ActualFieldName | string | Returns the actual field name |
Caption | string | Returns the caption |
DateSubType | BCE.AutoCount.UDF.UDFDateSubType | Returns the UDF Date Sub Type |
FieldName | string | Returns the field name |
Type | BCE.AutoCount.UDF.UDFType | Returns the UDF Type |
UDFDateSubType enum
The enum for the UDF Date Sub types.
Enum Name |
---|
Date |
DateTime |
Time |
UDFLayout class
This class is used to manage the UDF layout.
Namespace: | BCE.AutoCount.UDF |
Constructor: | UDFLayout(string tableName, BCE.Data.DBSetting dbSetting) |
UDFList class
This class is used to manage the UDF lists.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | UDFList(BCE.Data.DBSetting dbSetting) | |
Properties: | ||
Name | Type | Description |
this[string listName] | BCE.AutoCount.UDF.List | Returns the list by name. Returns null if field not found |
Methods: | ||
Name | Parameter | Description |
Add(string name, string[] items) | name: List name items: List of items | Adds a List into the current UDFList object. |
Add(BCE.AutoCount.UDF.List list) | list: A List object | Adds a List into the current UDFList. |
Delete(string name) | name: The name of the UDF List | Deletes the UDF List. Returns a boolean value. |
GetNames() | Returns an array of string containing the names of List stored in the UDFList | |
IsValidFieldName(string name) | name: the list name | Checks if the list name is valid for the UDFList. Returns a boolean value. |
Save() | Saves the UDFList object. |
UDFTable class
This class is used to manage the UDF of a table.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | UDFTable(string tableName, BCE.Data.DBSetting dbSetting) | |
Properties: | ||
Name | Type | Description |
Count | int | Returns the number of fields |
Table | System.Data.DataTable | Returns the DataTable of the UDFTable |
this[string name] | BCE.AutoCount.UDF.Field | Returns the field by name. Returns null if field not found |
this[int index] | BCE.AutoCount.UDF.Field | Returns the field by the specified index. Returns null if field not found |
Methods: | ||
Name | Parameter | Description |
Add(string name, BCE.AutoCount.UDF.UDFType type, string caption) | name: Field name type: Field type caption: Caption | Adds a UDF Field into the current UDFTable. Returns a new field object. |
Add(BCE.AutoCount.UDF.Field field) | field: The UDF Field object | Adds a UDF Field into the current UDFTable. Returns an integer index of the field. |
Delete(string name) | name: The name of the UDF Field | Deletes the UDF Field in the UDF Table. Returns a boolean value. |
Delete(int index) | index: the index of the field. | Deletes the UDF Field in the UDF Table by using the index of the UDF Field. |
IsValidFieldName(string name) | name: the field name of the field | Checks if the field name is valid for the UDF table. Returns a boolean value. |
Move(int index, int newIndex) | index: The current index of the field you wish to move newIndex: The new index you wish to move the field to | Move a UDF Field to a new index from its old position. |
Save() | Saves the UDFTable object. |
UDFType enum
The enum for the UDF field types.
Enum Name |
---|
Boolean |
Date |
Decimal |
ImageLink |
Integer |
Memo |
RichText |
System |
Text |
UDFUtil class
The utility class that handles general UDF User Interface setup and Search capabilities.
Namespace: | BCE.AutoCount.UDF | |
Constructor: | UDFUtil(BCE.Data.DBSetting dbSetting) | |
Methods: | ||
Name | Parameter | Description |
AddBuildLookupEditEventHandler(BCE.AutoCount.UDF.BuildLookupEditEventHandler handler) | handler: | |
AddUDFIntoAdvancedSearch(BCE.AutoCount.SearchFilter.SearchCriteria criteria, string tableName, string prefix) | criteria: tableName: prefix: | |
CreateEditor(string tableName, string udfFieldName, object dataSource) | tableName: udfFieldName: dataSource: | |
GenerateUDFSearchString(System.Data.SqlClient.SqlCommand cmd, string masterTableName, string masterAlias, string detailTableName, string detailAlias, string searchMsg) | cmd: masterTableName: masterAlias: detailTableName: detailAlias: searchMsg: | |
GenerateUDFSearchString(System.Data.SqlClient.SqlCommand cmd, string tableName, string aliasName, string searchMsg) | cmd: tableName: aliasName: searchMsg: | |
GetUDF(string tableName) | tableName: | |
GetUDFSQLColumns(string prefix, string tableName) | prefix: tableName: | |
SetDefaultValue(string tableName, System.Data.DataTable table) | tableName: table: | |
SetupDetailListingReportGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string masterTableName, string detailTableName) | gridView: masterTableName: detailTableName: | |
SetupGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string tableName, bool includeMemoAndRichText) | gridView: tableName: includeMemoAndRichText: | |
SetupGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string tableName) | gridView: tableName: | |
SetupLayoutControl(DevExpress.XtraLayout.TabbedControlGroup tabGroup, string tableName, object dataSource) | tabGroup: tableName: dataSource: | |
SetupListingReportGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string masterTableName) | gridView: masterTableName: | |
SetupReadOnlyGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string tableName, bool includeMemoAndRichText) | gridView: tableName: includeMemoAndRichText: | |
SetupReadOnlyGrid(DevExpress.XtraGrid.Views.Grid.GridView gridView, string tableName) | gridView: tableName: | |
SetupTabControl(DevExpress.XtraTab.XtraTabControl tabControl, string tableName, object dataSource) | tabControl: tableName: dataSource: | |
SetupTreeListControl(DevExpress.XtraTreeList.TreeList treeList, string tableName, bool includeMemoAndRichText) | treeList: tableName: includeMemoAndRichText: | |
SetupTreeListControl(DevExpress.XtraTreeList.TreeList treeList, string tableName) | treeList: tableName: | |
ValidateRequiredColumns(string tableName, System.Data.DataTable table, out System.Data.DataRow outRow, out string columnDisplayName, out string columnName) | tableName: table: outRow: columnDisplayName: columnName: |
UDF Supported Table
The following table list the tables that support UDF in it and can be use together with the UDFTable class.
Table Name | Category | Description |
---|---|---|
APInvoice | A/P | A/P Invoice |
APInvoiceDTL | A/P | A/P Invoice Detail |
APDN | A/P | A/P Debit Note |
APDNDTL | A/P | A/P Debit Note Detail |
APCN | A/P | A/P Credit Note |
APCNDTL | A/P | A/P Credit Note Detail |
APPayment | A/P | A/P Payment |
APPaymentDTL | A/P | A/P Payment Detail |
APRefund | A/P | A/P Refund |
APRefundDTL | A/P | A/P Refund Detail |
APDeposit | A/P | A/P Deposit |
APDepositDTL | A/P | A/P Deposit Detail |
ARInvoice | A/R | A/R Invoice |
ARInvoiceDTL | A/R | A/R Invoice Detail |
ARDN | A/R | A/R Debit Note |
ARDNDTL | A/R | A/R Debit Note Detail |
ARCN | A/R | A/R Credit Note |
ARCNDTL | A/R | A/R Credit Note Detail |
ARPayment | A/R | A/R Payment |
ARPaymentDTL | A/R | A/R Payment Detail |
ARRefund | A/R | A/R Refund |
ARRefundDTL | A/R | A/R Refund Detail |
ARAPContra | A/R | A/R A/P Contra |
ARDeposit | A/R | A/R Deposit |
ARDepositDTL | A/R | A/R Deposit Detail |
BonusPointADJ | Bonus Point | Bonus Point Adjustment |
BonusPointADJDTL | Bonus Point | Bonus Point Adjustment Detail |
CB | G/L | Cash Book Entry |
CBDTL | G/L | Cash Book Entry Detail |
JE | G/L | Journal Entry |
JEDTL | G/L | Journal Entry Detail |
Debtor | Maintenance | Debtor |
Creditor | Maintenance | Creditor |
DebtorType | Maintenance | Debtor Type |
CreditorType | Maintenance | Creditor Type |
Item | Maintenance | Stock Item |
ItemUOM | Maintenance | Stock Item UOM |
ItemType | Maintenance | Stock Item Type |
ItemGroup | Maintenance | Stock Group |
ItemPrice | Maintenance | Item Price |
Package | Maintenance | Item Package |
PackageDTL | Maintenance | Item Package Detail |
ItemBOM | Maintenance | Item BOM |
Location | Maintenance | Stock Location |
SalesAgent | Maintenance | Sales Agent |
PurchaseAgent | Maintenance | Purchase Agent |
Area | Maintenance | Area |
ShippingMethod | Maintenance | Shipping Method |
PriceCategory | Maintenance | Price Category |
TaxType | Maintenance | Tax Type |
DNType | Maintenance | D/N Type |
CNType | Maintenance | C/N Type |
CURRENCY | Maintenance | Currency |
CurrRate | Maintenance | Currency Rate |
Journal | Maintenance | Journal Type |
PaymentMethod | Maintenance | Payment Method |
Project | Maintenance | Project |
Dept | Maintenance | Department |
Member | Maintenance | Member |
MemberType | Maintenance | Member Type |
Branch | Maintenance | Debtor/Creditor Branch |
ItemBatch | Maintenance | Item Batch |
ASM | Manufacturing | Stock Assembly |
ASMDTL | Manufacturing | Stock Assembly Detail |
ASMOrder | Manufacturing | Stock Assembly Order |
ASMOrderDTL | Manufacturing | Stock Assembly Order Detail |
BOMOptional | Manufacturing | BOM Optional |
BOMOptionalDTL | Manufacturing | BOM Optional Detail |
RQ | Purchase | Request for Quotation |
RQDTL | Purchase | Request for Quotation Detail |
PO | Purchase | Purchase Order |
PODTL | Purchase | Purchase Order Detail |
GR | Purchase | Goods Received Note |
GRDTL | Purchase | Goods Received Note Detail |
PI | Purchase | Purchase Invoice |
PIDTL | Purchase | Purchase Invoice Detail |
CP | Purchase | Cash Purchase |
CPDTL | Purchase | Cash Purchase Detail |
PR | Purchase | Purchase Return |
PRDTL | Purchase | Purchase Return Detail |
XP | Purchase | Cancel Purchase Order |
XPDTL | Purchase | Cancel Purchase Order Detail |
GT | Purchase | Goods Return |
GTDTL | Purchase | Goods Return Detail |
SupplierCSGN | Purchase | Supplier Consignment |
SupplierCSGNDTL | Purchase | Supplier Consignment Detail |
QT | Sales | Quotation |
QTDTL | Sales | Quotation Detail |
SO | Sales | Sales Order |
SODTL | Sales | Sales Order Detail |
DO | Sales | Deliver Order |
DODTL | Sales | Delivery Order Detail |
IV | Sales | Invoice |
IVDTL | Sales | Invoice Detail |
CS | Sales | Cash Sale |
CSDTL | Sales | Cash Sale Detail |
DN | Sales | Debit Note |
DNDTL | Sales | Debit Note Detail |
CN | Sales | Credit Note |
CNDTL | Sales | Credit Note detail |
XS | Sales | Cancel Sales Order |
XSDTL | Sales | Cancel Sales Order Detail |
DR | Sales | Delivery Return |
DRDTL | Sales | Delivery Return Detail |
CSGN | Sales | Consignment |
CSGNDTL | Sales | Consignment Detail |
ADJ | Stock | Stock Adjustment |
ADJDTL | Stock | Stock Adjustment Detail |
ISS | Stock | Stock Issue |
ISSDTL | Stock | Stock Issue Detail |
RCV | Stock | Stock Receive |
RCVDTL | Stock | Stock Receive Detail |
WOFF | Stock | Stock Write-Off |
WOFFDTL | Stock | Stock Write-Off Detail |
UOMConv | Stock | Stock UOM Conversion |
UOMConvDTL | Stock | Stock UOM Conversion Detail |
UpdateCost | Stock | Stock Update Cost |
UpdateCostDTL | Stock | Stock Update Cost Detail |
XFER | Stock | Stock Transfer |
XFERDTL | Stock | Stock Transfer Detail |
Delegates
AfterSaveUDFEventHandler
Represents the method that will handle the AfterSaveUDF event. This is used in the UDFTable Class AfterSaveUDF event.
BuildLookupEditEventHandler
Represents the method that will handle the BuildLookupEdit event.