Class SubmitService

Namespace

Dynamicweb.Forms

Assembly

Dynamicweb.Forms.dll

public abstract class SubmitService

Inheritance

object

SubmitService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddSubmitData(int, SubmitData)

Add submission data.

public virtual void AddSubmitData(int submitId, SubmitData submitData)

Parameters

submitId int

The ID of the submission.

submitData SubmitData

The submission data to add.

ConvertToCsv(int, bool)

Converts the submissions for a given form to a CSV string.

public virtual string ConvertToCsv(int formId, bool exportHeaders)

Parameters

formId int

The ID of the form.

exportHeaders bool

Determines if headers should be exported, or not.

Returns

string

ConvertToCsv(int, bool, int)

Converts the submissions for a given form and page to a CSV string.

public virtual string ConvertToCsv(int formId, bool exportHeaders, int pageId)

Parameters

formId int

The ID of the form.

exportHeaders bool

Determines if headers should be exported, or not.

pageId int

The ID of the page.

Returns

string

Delete(int)

Deletes the submission by ID.

public virtual void Delete(int submitId)

Parameters

submitId int

The ID of the submission to delete.

DeleteByFormId(int)

Deletes all submissions that belongs to the given form ID.

public virtual void DeleteByFormId(int formId)

Parameters

formId int

The ID of the form.

GetAll()

Get all submits.

public virtual IEnumerable<Submit> GetAll()

Returns

IEnumerable<Submit>

GetById(int)

Get submit by id.

public virtual Submit? GetById(int submitId)

Parameters

submitId int

The ID of the submission.

Returns

Submit

GetLastSubmitDate(Form)

Gets the most recent date the given form was submitted.

public virtual DateTime GetLastSubmitDate(Form form)

Parameters

form Form

The form.

Returns

DateTime

GetLastSubmitDate(int)

Gets the most recent date the given form was submitted.

public virtual DateTime GetLastSubmitDate(int formId)

Parameters

formId int

The ID of the form.

Returns

DateTime

GetSubmitCount(Form)

Gets the submit count for a given form.

public virtual int GetSubmitCount(Form form)

Parameters

form Form

The form.

Returns

int

GetSubmitCount(Form, int)

Gets the submit count for a given form and page.

public virtual int GetSubmitCount(Form form, int pageId)

Parameters

form Form

The form.

pageId int

The ID of the page.

Returns

int

GetSubmitCount(int)

Gets the submit count for a given form.

public virtual int GetSubmitCount(int formId)

Parameters

formId int

The ID of the form.

Returns

int

GetSubmitCount(int, int)

Gets the submit count for a given form and page.

public virtual int GetSubmitCount(int formId, int pageId)

Parameters

formId int

The ID of the form.

pageId int

The ID of the page.

Returns

int

GetSubmits(int)

Get all submits for a form.

public virtual IEnumerable<Submit> GetSubmits(int formId)

Parameters

formId int

The ID of the form.

Returns

IEnumerable<Submit>

GetSubmitsByPage(int, int)

Get all submits for a given form and page.

public virtual IEnumerable<Submit> GetSubmitsByPage(int formId, int pageId)

Parameters

formId int

The ID of the form.

pageId int

The ID of the page.

Returns

IEnumerable<Submit>

GetSubmitsByPageAndUser(int, int, int)

Get all submits for a given form, page and user.

public virtual IEnumerable<Submit> GetSubmitsByPageAndUser(int formId, int pageId, int userId)

Parameters

formId int

The ID of the form.

pageId int

The ID of the page.

userId int

The ID of the user.

Returns

IEnumerable<Submit>

GetSubmitsByPageNumber(int, int, int, SubmitSortBy, SortOrderType)

Get submits for a given form, by page number.

public virtual IEnumerable<Submit> GetSubmitsByPageNumber(int formId, int pageNumber, int pageSize, SubmitSortBy sortBy, SortOrderType sortOrderType)

Parameters

formId int

The ID of the form.

pageNumber int

The page number.

pageSize int

Size of the page.

sortBy SubmitSortBy

Sort by field.

sortOrderType SortOrderType

Sort order type.

Returns

IEnumerable<Submit>

GetSubmitsByUser(int, int)

Get all submits for a given form and user.

public virtual IEnumerable<Submit> GetSubmitsByUser(int formId, int userId)

Parameters

formId int

The ID of the form.

userId int

The ID of the user.

Returns

IEnumerable<Submit>

GetValueString(Submit)

Gets a combined value string for a submit. Each value is delimited by a semicolon.

public virtual string GetValueString(Submit submit)

Parameters

submit Submit

The submission.

Returns

string

GetValueStrings(IEnumerable<int>)

Gets a combined value string for a collection of submit IDs. Each value is delimited by a semicolon.

public virtual IDictionary<int, string> GetValueStrings(IEnumerable<int> submitIds)

Parameters

submitIds IEnumerable<int>

The submission IDs.

Returns

IDictionary<int, string>

Save(Submit)

Saves the submission.

public virtual void Save(Submit submit)

Parameters

submit Submit

The submission to save.