Bitrix API

Column uses ColumnFields

Table of Contents

Methods

__construct()  : mixed
getAlign()  : string
getCssClassName()  : string|null
getCssColorClassName()  : string|null
getCssColorValue()  : string|null
getEditable()  : Config|null
getFirstOrder()  : string
getHint()  : Hint|null
getIcon()  : Icon|null
getId()  : string
getLayout()  : Layout
getName()  : string|null
getNextSortOrder()  : string
getSection()  : string|null
getSelect()  : array<string|int, mixed>
getSort()  : string|null
getSortIndex()  : int
getSortOrder()  : string
getSortState()  : string|null
getSortUrl()  : string|null
getTitle()  : string|null
getType()  : string
getWidth()  : int|null
isDefault()  : bool
isEditable()  : bool
isMultiple()  : bool
isNecessary()  : bool
Column is always included in the selection, even if it is not currently displayed in the grid.
isPreventDefault()  : bool
isResizeable()  : bool
isShift()  : bool
isShown()  : bool
isShowname()  : bool
isSticked()  : bool
isValidCssColorValue()  : bool
setAlign()  : self
setCssClassName()  : self
setCssColorClassName()  : self
Set color class name.
setCssColorValue()  : self
Set color css value.
setDefault()  : self
setEditable()  : self
setFirstOrder()  : self
setHint()  : self
setIcon()  : self
setId()  : self
setMultiple()  : self
setName()  : self
setNecessary()  : self
setPreventDefault()  : self
setResizeable()  : self
setSection()  : self
setSelect()  : self
setShift()  : self
setShown()  : self
setShowname()  : self
setSort()  : self
setSortIndex()  : self
setSortState()  : self
setSortUrl()  : self
setSticked()  : self
setTitle()  : self
setType()  : $this
Set column's type.
setWidth()  : self
Sets column width.

Methods

__construct()

public __construct(string $id[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$id : string
$params : array<string|int, mixed> = []

params array. Recommended using set* methods.

getAlign()

public getAlign() : string
Return values
string

getCssClassName()

public getCssClassName() : string|null
Return values
string|null

getCssColorClassName()

public getCssColorClassName() : string|null
Return values
string|null

getCssColorValue()

public getCssColorValue() : string|null
Return values
string|null

getFirstOrder()

public getFirstOrder() : string
Return values
string

getId()

public getId() : string
Return values
string

getName()

public getName() : string|null
Return values
string|null

getNextSortOrder()

public getNextSortOrder() : string
Return values
string

getSection()

public getSection() : string|null
Return values
string|null

getSelect()

public getSelect() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSort()

public getSort() : string|null
Return values
string|null

getSortIndex()

public getSortIndex() : int
Return values
int

getSortOrder()

public getSortOrder() : string
Return values
string

getSortState()

public getSortState() : string|null
Return values
string|null

getSortUrl()

public getSortUrl() : string|null
Return values
string|null

getTitle()

public getTitle() : string|null
Return values
string|null

getType()

public getType() : string
Return values
string

getWidth()

public getWidth() : int|null
Return values
int|null

isDefault()

public isDefault() : bool
Return values
bool

isEditable()

public isEditable() : bool
Return values
bool

isMultiple()

public isMultiple() : bool
Return values
bool

isNecessary()

Column is always included in the selection, even if it is not currently displayed in the grid.

public isNecessary() : bool
Return values
bool

isPreventDefault()

public isPreventDefault() : bool
Return values
bool

isResizeable()

public isResizeable() : bool
Return values
bool

isShowname()

public isShowname() : bool
Return values
bool

isSticked()

public isSticked() : bool
Return values
bool

isValidCssColorValue()

public static isValidCssColorValue(string $value) : bool
Parameters
$value : string
Return values
bool

setAlign()

public setAlign(string|null $align) : self
Parameters
$align : string|null
Return values
self

setCssClassName()

public setCssClassName(string|null $cssClassName) : self
Parameters
$cssClassName : string|null
Return values
self

setCssColorClassName()

Set color class name.

public setCssColorClassName(string $color) : self

If need to set specific color value, see setCssColorValue method

Parameters
$color : string

class name of style

Tags
see
Color

for details about available values.

Return values
self

setCssColorValue()

Set color css value.

public setCssColorValue(string $value) : self
Parameters
$value : string

in css format: #222, rgb(1,2,3), hsl(2,3,4), ...

Return values
self

setDefault()

public setDefault(bool $default) : self
Parameters
$default : bool
Return values
self

setEditable()

public setEditable(mixed $value) : self
Parameters
$value : mixed
Return values
self

setFirstOrder()

public setFirstOrder(string $firstOrder) : self
Parameters
$firstOrder : string

asc or desc value

Return values
self

setHint()

public setHint(Hint|null $value) : self
Parameters
$value : Hint|null
Return values
self

setIcon()

public setIcon(Icon|null $value) : self
Parameters
$value : Icon|null
Return values
self

setId()

public setId(string $id) : self
Parameters
$id : string
Return values
self

setMultiple()

public setMultiple(bool $multiple) : self
Parameters
$multiple : bool
Return values
self

setName()

public setName(string|null $name) : self
Parameters
$name : string|null
Return values
self

setNecessary()

public setNecessary(bool $necessary) : self
Parameters
$necessary : bool
Return values
self

setPreventDefault()

public setPreventDefault(bool $preventDefault) : self
Parameters
$preventDefault : bool
Return values
self

setResizeable()

public setResizeable(bool $resizeable) : self
Parameters
$resizeable : bool
Return values
self

setSection()

public setSection(string|null $value) : self
Parameters
$value : string|null
Return values
self

setSelect()

public setSelect(array<string|int, mixed> $select) : self
Parameters
$select : array<string|int, mixed>
Return values
self

setShift()

public setShift(bool $shift) : self
Parameters
$shift : bool
Return values
self

setShown()

public setShown(bool $value) : self
Parameters
$value : bool
Return values
self

setShowname()

public setShowname(bool $showname) : self
Parameters
$showname : bool
Return values
self

setSort()

public setSort(string|null $sort) : self
Parameters
$sort : string|null
Return values
self

setSortIndex()

public setSortIndex(int $value) : self
Parameters
$value : int
Return values
self

setSortState()

public setSortState(string $value) : self
Parameters
$value : string

asc or desc

Return values
self

setSortUrl()

public setSortUrl(string $value) : self
Parameters
$value : string
Return values
self

setSticked()

public setSticked(bool $sticked) : self
Parameters
$sticked : bool
Return values
self

setTitle()

public setTitle(string|null $title) : self
Parameters
$title : string|null
Return values
self

setType()

Set column's type.

public setType(string $type) : $this
Parameters
$type : string
Tags
see
Type
Return values
$this

setWidth()

Sets column width.

public setWidth(int|null $width) : self
Parameters
$width : int|null

pixels

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results