Class FileManagerColumnBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
FileManagerColumnBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class FileManagerColumnBuilder : ControlBuilder
Constructors
FileManagerColumnBuilder()
Declaration
public FileManagerColumnBuilder()
FileManagerColumnBuilder(List<FileManagerColumn>)
Declaration
public FileManagerColumnBuilder(List<FileManagerColumn> collection)
Parameters
Methods
Add()
Declaration
AllowResizing(Boolean)
If allowResizing set to false, it disables resize option of a particular column.
Declaration
public FileManagerColumnBuilder AllowResizing(bool allowResizing)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowResizing |
|
Returns
AllowSorting(Boolean)
If allowSorting set to false, then it disables sorting option of a particular column.
By default all columns are sortable.
Declaration
public FileManagerColumnBuilder AllowSorting(bool allowSorting)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowSorting |
|
Returns
CustomAttributes(Object)
The CSS styles and attributes of the content cells of a particular column can be customized.
Declaration
public FileManagerColumnBuilder CustomAttributes(object customAttributes)
Parameters
| Type |
Name |
Description |
| System.Object |
customAttributes |
|
Returns
It is used to change display value with the given format and does not affect the original data.
Gets the format from the user which can be standard or custom
number
and date formats.
Declaration
public FileManagerColumnBuilder CustomFormat(object customFormat)
Parameters
| Type |
Name |
Description |
| System.Object |
customFormat |
|
Returns
Field(String)
Defines the field name of column which is mapped with mapping name of DataSource.
The bounded columns can be sort, filter and group etc.,
The field name must be a valid JavaScript identifier,
the first character must be an alphabet and should not contain spaces and special characters.
Declaration
public FileManagerColumnBuilder Field(string field)
Parameters
| Type |
Name |
Description |
| System.String |
field |
|
Returns
It is used to change display value with the given format and does not affect the original data.
Gets the format from the user which can be standard or custom
number
and date formats.
Declaration
public FileManagerColumnBuilder Format(string format)
Parameters
| Type |
Name |
Description |
| System.String |
format |
|
Returns
HeaderTemplate(String)
Defines the column template as string or HTML element ID which is used to add customized element in the column header.
Declaration
public FileManagerColumnBuilder HeaderTemplate(string headerTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
headerTemplate |
|
Returns
HeaderText(String)
Defines the header text of column which is used to display in column header.
If headerText is not defined, then field name value will be assigned to header text.
Declaration
public FileManagerColumnBuilder HeaderText(string headerText)
Parameters
| Type |
Name |
Description |
| System.String |
headerText |
|
Returns
HeaderTextAlign(TextAlign)
Define the alignment of column header which is used to align the text of column header.
Declaration
public FileManagerColumnBuilder HeaderTextAlign(TextAlign headerTextAlign)
Parameters
| Type |
Name |
Description |
| TextAlign |
headerTextAlign |
|
Returns
Column visibility can change based on Media Queries.
hideAtMedia accepts only valid Media Queries.
Declaration
public FileManagerColumnBuilder HideAtMedia(string hideAtMedia)
Parameters
| Type |
Name |
Description |
| System.String |
hideAtMedia |
|
Returns
IsPrimaryKey(Boolean)
If isPrimaryKey is set to true, considers this column as the primary key constraint.
Declaration
public FileManagerColumnBuilder IsPrimaryKey(bool isPrimaryKey)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isPrimaryKey |
|
Returns
MaxWidth(Double)
Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
Declaration
public FileManagerColumnBuilder MaxWidth(double maxWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
maxWidth |
|
Returns
MaxWidth(String)
Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
Declaration
public FileManagerColumnBuilder MaxWidth(string maxWidth)
Parameters
| Type |
Name |
Description |
| System.String |
maxWidth |
|
Returns
MinWidth(Double)
Defines the minimum width of the column in pixels or percentage.
Declaration
public FileManagerColumnBuilder MinWidth(double minWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
minWidth |
|
Returns
MinWidth(String)
Defines the minimum width of the column in pixels or percentage.
Declaration
public FileManagerColumnBuilder MinWidth(string minWidth)
Parameters
| Type |
Name |
Description |
| System.String |
minWidth |
|
Returns
SortComparer(String)
Defines the custom sort comparer function.
The sort comparer function has the same functionality like
Array.sort sort comparer.
Declaration
public FileManagerColumnBuilder SortComparer(string sortComparer)
Parameters
| Type |
Name |
Description |
| System.String |
sortComparer |
|
Returns
Template(String)
Defines the column template that renders customized element in each cell of the column.
It accepts either template string or HTML element ID.
Declaration
public FileManagerColumnBuilder Template(string template)
Parameters
| Type |
Name |
Description |
| System.String |
template |
|
Returns
TextAlign(TextAlign)
Defines the alignment of the column in both header and content cells.
Declaration
public FileManagerColumnBuilder TextAlign(TextAlign textAlign)
Parameters
Returns
Type(String)
Defines the data type of the column.
Declaration
public FileManagerColumnBuilder Type(string type)
Parameters
| Type |
Name |
Description |
| System.String |
type |
|
Returns
Width(Double)
Defines the width of the column in pixels or percentage.
Declaration
public FileManagerColumnBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
Width(String)
Defines the width of the column in pixels or percentage.
Declaration
public FileManagerColumnBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
