Bitrix API

ColumnFields

Column fields used in the UI, in particular the `main.ui.grid` component.

Table of Contents

Methods

getAlign()  : string
getCssClassName()  : string|null
getCssColorClassName()  : string|null
getCssColorValue()  : string|null
getFirstOrder()  : string
getHint()  : Hint|null
getIcon()  : Icon|null
getLayout()  : Layout
getNextSortOrder()  : string
getSection()  : string|null
getSortIndex()  : int
getSortOrder()  : string
getSortState()  : string|null
getSortUrl()  : string|null
getTitle()  : string|null
getWidth()  : int|null
isDefault()  : bool
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.
setFirstOrder()  : self
setHint()  : self
setIcon()  : self
setPreventDefault()  : self
setResizeable()  : self
setSection()  : self
setShift()  : self
setShown()  : self
setShowname()  : self
setSortIndex()  : self
setSortState()  : self
setSortUrl()  : self
setSticked()  : self
setTitle()  : self
setWidth()  : self
Sets column width.

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

getNextSortOrder()

public getNextSortOrder() : string
Return values
string

getSection()

public getSection() : 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

getWidth()

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

isDefault()

public abstract isDefault() : 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

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

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

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

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

setWidth()

Sets column width.

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

pixels

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results