Class BaseFormController

Represents base form controller.

Inheritance
System.Object
BaseFormController
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: Mediachase.BusinessFoundation.MetaForm
Assembly: Mediachase.BusinessFoundation.dll
Version: 10.8.0
Syntax
public class BaseFormController

Constructors

BaseFormController(FormDocument)

Initializes a new instance of the BaseFormController class.

Declaration
protected BaseFormController(FormDocument fDocument)
Parameters
Type Name Description
FormDocument fDocument

The f document.

Fields

p_fDocument

Declaration
protected FormDocument p_fDocument
Field Value
Type Description
FormDocument

SmartTableLayoutType

Declaration
public const string SmartTableLayoutType = "SmartTableLayout"
Field Value
Type Description
System.String

Properties

FDocument

Gets or sets the F document.

Declaration
public FormDocument FDocument { get; set; }
Property Value
Type Description
FormDocument

The F document.

FTable

Gets the F table.

Declaration
public FormTable FTable { get; }
Property Value
Type Description
FormTable

The F table.

Methods

AddFormItem(FormItem, FormSection)

Adds the form item.

Declaration
protected bool AddFormItem(FormItem fItem, FormSection sec)
Parameters
Type Name Description
FormItem fItem

The f item.

FormSection sec

The sec.

Returns
Type Description
System.Boolean

AddFormItem(FormItem, Guid)

Adds the form item.

Declaration
public bool AddFormItem(FormItem fItem, Guid sectionUid)
Parameters
Type Name Description
FormItem fItem

The f item.

System.Guid sectionUid

The section uid.

Returns
Type Description
System.Boolean

AddSection(FormSection)

Adds the section.

Declaration
public void AddSection(FormSection sec)
Parameters
Type Name Description
FormSection sec

The sec.

AddSection(FormSection, FormCell)

Adds the section.

Declaration
protected void AddSection(FormSection sec, FormCell itemCell)
Parameters
Type Name Description
FormSection sec

The sec.

FormCell itemCell

The item cell.

AddSection(FormSection, String)

Adds the section.

Declaration
public void AddSection(FormSection sec, string cellName)
Parameters
Type Name Description
FormSection sec

The sec.

System.String cellName

Name of the cell.

AddSectionAfter(FormSection, Guid)

Adds the section after.

Declaration
public void AddSectionAfter(FormSection sec, Guid itemUid)
Parameters
Type Name Description
FormSection sec

The sec.

System.Guid itemUid

The item uid.

AddSectionBefore(FormSection, FormSection)

Adds the section before.

Declaration
protected void AddSectionBefore(FormSection sec, FormSection itemBefore)
Parameters
Type Name Description
FormSection sec

The sec.

FormSection itemBefore

The item before.

AddSectionBefore(FormSection, Guid)

Adds the section before.

Declaration
public void AddSectionBefore(FormSection sec, Guid itemUid)
Parameters
Type Name Description
FormSection sec

The sec.

System.Guid itemUid

The item uid.

CanChangeColspan(FormItem)

Can Change Colspan For Selected Field

Declaration
public bool CanChangeColspan(FormItem fItem)
Parameters
Type Name Description
FormItem fItem

The f item.

Returns
Type Description
System.Boolean

true if this instance [can change colspan] the specified f item; otherwise, false.

CreateFormItemCustom(Int32, Int32, Int32, Int32, Boolean, String, Unit, Int16, String, String)

Creates the form item custom.

Declaration
public static FormItem CreateFormItemCustom(int rowIndex, int cellIndex, int rowSpan, int colSpan, bool showTitle, string title, Unit labelWidth, short tabIndex, string controlType, string controlProperty)
Parameters
Type Name Description
System.Int32 rowIndex

Index of the row.

System.Int32 cellIndex

Index of the cell.

System.Int32 rowSpan

The row span.

System.Int32 colSpan

The col span.

System.Boolean showTitle

if set to true [show title].

System.String title

The title.

System.Web.UI.WebControls.Unit labelWidth

Width of the label.

System.Int16 tabIndex

Index of the tab.

System.String controlType

Type of the control.

System.String controlProperty

The control property.

Returns
Type Description
FormItem

CreateSectionCustom(BorderType, Boolean, String, String, String)

Creates the section custom.

Declaration
public static FormSection CreateSectionCustom(BorderType borderType, bool showTitle, string title, string controlType, string controlProperty)
Parameters
Type Name Description
BorderType borderType

Type of the border.

System.Boolean showTitle

if set to true [show title].

System.String title

The title.

System.String controlType

Type of the control.

System.String controlProperty

The control property.

Returns
Type Description
FormSection

CreateSectionSTL(BorderType, Boolean, String, Unit, String, Int32)

Creates the section STL.

Declaration
public static FormSection CreateSectionSTL(BorderType borderType, bool showTitle, string title, Unit width, string columns, int cellPadding)
Parameters
Type Name Description
BorderType borderType

Type of the border.

System.Boolean showTitle

if set to true [show title].

System.String title

The title.

System.Web.UI.WebControls.Unit width

The width.

System.String columns

The columns.

System.Int32 cellPadding

The cell padding.

Returns
Type Description
FormSection

GetCurrentCultureLabel(FormItem)

Gets the current culture label.

Declaration
public static string GetCurrentCultureLabel(FormItem formItem)
Parameters
Type Name Description
FormItem formItem

The form item.

Returns
Type Description
System.String

GetMaxRowSpan(FormItem)

Gets the max row span.

Declaration
public int GetMaxRowSpan(FormItem fItem)
Parameters
Type Name Description
FormItem fItem

The f item.

Returns
Type Description
System.Int32

Max RowSpan Value For Selected Field

GetMaxSectionIndex(FormCell)

Gets the index of the max section.

Declaration
protected static int GetMaxSectionIndex(FormCell cell)
Parameters
Type Name Description
FormCell cell

The cell.

Returns
Type Description
System.Int32

GetSectionByUid(Guid)

Declaration
public FormSection GetSectionByUid(Guid uid)
Parameters
Type Name Description
System.Guid uid
Returns
Type Description
FormSection

GetSectionForFormItem(FormItem)

Gets the section for form item.

Declaration
public FormSection GetSectionForFormItem(FormItem fItem)
Parameters
Type Name Description
FormItem fItem

The f item.

Returns
Type Description
FormSection

GetSmartTableLayoutDataSource(Guid)

Gets the smart table layout data source.

Declaration
public List<SmartTableLayoutDataItem> GetSmartTableLayoutDataSource(Guid secUid)
Parameters
Type Name Description
System.Guid secUid

The sec uid.

Returns
Type Description
System.Collections.Generic.List<SmartTableLayoutDataItem>

GetSTLItemByUid(Guid)

Gets the STL item by uid.

Declaration
public FormItem GetSTLItemByUid(Guid uid)
Parameters
Type Name Description
System.Guid uid

The uid.

Returns
Type Description
FormItem

GetSTLItemByUid(Guid, out FormSection)

Gets the STL item by uid.

Declaration
protected FormItem GetSTLItemByUid(Guid uid, out FormSection itemSection)
Parameters
Type Name Description
System.Guid uid

The uid.

FormSection itemSection

The item section.

Returns
Type Description
FormItem

GetTableLayoutDataSource()

Gets the table layout data source.

Declaration
public List<TableLayoutDataItem> GetTableLayoutDataSource()
Returns
Type Description
System.Collections.Generic.List<TableLayoutDataItem>

IsFullBlock(Guid[,], Int32, Int32)

Determines whether [is full block] [the specified matrix].

Declaration
protected static bool IsFullBlock(Guid[, ] matrix, int row1, int row2)
Parameters
Type Name Description
System.Guid[,] matrix

The matrix.

System.Int32 row1

The row1.

System.Int32 row2

The row2.

Returns
Type Description
System.Boolean

true if [is full block] [the specified matrix]; otherwise, false.

MaxMatrixRow(Guid[,], Int32, Int32)

Maxes the matrix row.

Declaration
protected static int MaxMatrixRow(Guid[, ] matrix, int col, int maxRow)
Parameters
Type Name Description
System.Guid[,] matrix

The matrix.

System.Int32 col

The col.

System.Int32 maxRow

The max row.

Returns
Type Description
System.Int32

MoveFormItem(Guid, String)

Moves the form item.

Declaration
protected void MoveFormItem(Guid itemUid, string direction)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

System.String direction

The direction.

MoveFormItemDown(Guid)

Moves the form item down.

Declaration
public void MoveFormItemDown(Guid uid)
Parameters
Type Name Description
System.Guid uid

The uid.

MoveFormItemLeft(Guid)

Moves the form item left.

Declaration
public void MoveFormItemLeft(Guid uid)
Parameters
Type Name Description
System.Guid uid

The uid.

MoveFormItemRight(Guid)

Moves the form item right.

Declaration
public void MoveFormItemRight(Guid uid)
Parameters
Type Name Description
System.Guid uid

The uid.

MoveFormItemUp(Guid)

Moves the form item up.

Declaration
public void MoveFormItemUp(Guid uid)
Parameters
Type Name Description
System.Guid uid

The uid.

MoveSection(Guid, String)

Moves the section.

Declaration
protected void MoveSection(Guid itemUid, string direction)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

System.String direction

The direction.

MoveSectionDown(Guid)

Moves the section down.

Declaration
public void MoveSectionDown(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

MoveSectionLeft(Guid)

Moves the section left.

Declaration
public void MoveSectionLeft(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

MoveSectionRight(Guid)

Moves the section right.

Declaration
public void MoveSectionRight(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

MoveSectionToCell(FormSection, FormCell)

Moves the section to cell.

Declaration
protected void MoveSectionToCell(FormSection itemSection, FormCell newCell)
Parameters
Type Name Description
FormSection itemSection

The item section.

FormCell newCell

The new cell.

MoveSectionUp(Guid)

Moves the section up.

Declaration
public void MoveSectionUp(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

RemoveEmptyStringsFromSmartTableLayout(FormSection)

Removing Empty Rows From Section Back-Table

Declaration
protected void RemoveEmptyStringsFromSmartTableLayout(FormSection itemSection)
Parameters
Type Name Description
FormSection itemSection

The item section.

RemoveFormItem(FormItem)

Removes the form item.

Declaration
protected void RemoveFormItem(FormItem formItem)
Parameters
Type Name Description
FormItem formItem

The form item.

RemoveFormItem(Guid)

Removes the form item.

Declaration
public void RemoveFormItem(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.

RemoveFormItemFromSection(FormItem, FormSection)

Removes the form item from section.

Declaration
protected void RemoveFormItemFromSection(FormItem formItem, FormSection itemSection)
Parameters
Type Name Description
FormItem formItem

The form item.

FormSection itemSection

The item section.

RemoveSection(FormSection)

Removes the section.

Declaration
protected void RemoveSection(FormSection itemSection)
Parameters
Type Name Description
FormSection itemSection

The item section.

RemoveSection(Guid)

Removes the section.

Declaration
public void RemoveSection(Guid itemUid)
Parameters
Type Name Description
System.Guid itemUid

The item uid.