Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Custom Field Forms. More...

Inheritance diagram for MixERP.Net.Api.Core.CustomFieldFormController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "custom field form" entity. More...

long	Count ()
	Counts the number of custom field forms. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	Get ()
	Returns collection of custom field form for export. More...

MixERP.Net.Entities.Core.CustomFieldForm	Get (string formName)
	Returns an instance of custom field form. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	Get ([FromUri] string[] formNames)

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	GetPagedResult ()
	Creates a paginated collection containing 25 custom field forms on each page, sorted by the property FormName. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 custom field forms on each page, sorted by the property FormName. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of custom field forms using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 custom field forms on each page, sorted by the property FormName. More...

long	CountFiltered (string filterName)
	Counts the number of custom field forms using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldForm >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 custom field forms on each page, sorted by the property FormName. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of custom field forms. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for custom field forms. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for custom field forms. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of CustomFieldForm class. More...

void	Add (MixERP.Net.Entities.Core.CustomFieldForm customFieldForm)
	Adds your instance of CustomFieldForm class. More...

void	Edit (string formName, [FromBody] MixERP.Net.Entities.Core.CustomFieldForm customFieldForm)
	Edits existing record with your instance of CustomFieldForm class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of CustomFieldForm class. More...

void	Delete (string formName)
	Deletes an existing instance of CustomFieldForm class via FormName. More...

Properties
long	LoginId `[get]`

int	UserId `[get]`

int	OfficeId `[get]`

string	Catalog `[get]`

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Custom Field Forms.

Member Function Documentation

void MixERP.Net.Api.Core.CustomFieldFormController.Add ( MixERP.Net.Entities.Core.CustomFieldForm customFieldForm )

Adds your instance of CustomFieldForm class.

Parameters

customFieldForm Your instance of custom field forms class to add.

void MixERP.Net.Api.Core.CustomFieldFormController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of CustomFieldForm class.

Parameters

customFieldForm Your instance of custom field forms class to add or edit.

List<object> MixERP.Net.Api.Core.CustomFieldFormController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of CustomFieldForm class.

Parameters

collection Your collection of CustomFieldForm class to bulk import.

Returns: Returns list of imported formNames.

Exceptions

MixERPException Thrown when your any CustomFieldForm class in the collection is invalid or malformed.

long MixERP.Net.Api.Core.CustomFieldFormController.Count ( )

Counts the number of custom field forms.

Returns: Returns the count of the custom field forms.

long MixERP.Net.Api.Core.CustomFieldFormController.CountFiltered ( string filterName )

Counts the number of custom field forms using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered custom field forms.

long MixERP.Net.Api.Core.CustomFieldFormController.CountWhere ( [FromBody] dynamic filters )

Counts the number of custom field forms using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered custom field forms.

void MixERP.Net.Api.Core.CustomFieldFormController.Delete ( string formName )

Deletes an existing instance of CustomFieldForm class via FormName.

Parameters

formName Enter the value for FormName in order to find and delete the existing record.

void MixERP.Net.Api.Core.CustomFieldFormController.Edit	(	string	formName,
		[FromBody] MixERP.Net.Entities.Core.CustomFieldForm	customFieldForm
	)

Edits existing record with your instance of CustomFieldForm class.

Parameters

customFieldForm	Your instance of CustomFieldForm class to edit.
formName	Enter the value for FormName in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldForm> MixERP.Net.Api.Core.CustomFieldFormController.Get ( )

Returns collection of custom field form for export.

Returns

MixERP.Net.Entities.Core.CustomFieldForm MixERP.Net.Api.Core.CustomFieldFormController.Get ( string formName )

Returns an instance of custom field form.

Parameters

formName Enter FormName to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CustomFieldFormController.GetCustomFields ( )

A custom field is a user defined field for custom field forms.

Returns: Returns an enumerable custom field collection of custom field forms.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CustomFieldFormController.GetCustomFields ( string resourceId )

A custom field is a user defined field for custom field forms.

Returns: Returns an enumerable custom field collection of custom field forms.

IEnumerable<DisplayField> MixERP.Net.Api.Core.CustomFieldFormController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of custom field forms.

Returns: Returns an enumerable key/value collection of custom field forms.

EntityView MixERP.Net.Api.Core.CustomFieldFormController.GetEntityView ( )

Creates meta information of "custom field form" entity.

Returns: Returns the "custom field form" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldForm> MixERP.Net.Api.Core.CustomFieldFormController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 custom field forms on each page, sorted by the property FormName.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldForm> MixERP.Net.Api.Core.CustomFieldFormController.GetPagedResult ( )

Creates a paginated collection containing 25 custom field forms on each page, sorted by the property FormName.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldForm> MixERP.Net.Api.Core.CustomFieldFormController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 custom field forms on each page, sorted by the property FormName.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldForm> MixERP.Net.Api.Core.CustomFieldFormController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 custom field forms on each page, sorted by the property FormName.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The list of filter conditions.

Returns: Returns the requested page from the collection using the supplied filters.

The documentation for this class was generated from the following file:

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Core/CustomFieldFormController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation