Bitrix API

ConfigBuilder

FinalYes

Table of Contents

Constants

DOCUMENT_TYPE_CELL  = 'cell'
DOCUMENT_TYPE_SLIDE  = 'slide'
DOCUMENT_TYPE_WORD  = 'word'
MODE_EDIT  = 'edit'
MODE_VIEW  = 'view'
REVIEW_DISPLAY_FINAL  = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_FINAL
REVIEW_DISPLAY_MARKUP  = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_MARKUP
REVIEW_DISPLAY_ORIGINAL  = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_ORIGINAL
REVIEW_DISPLAY_SIMPLE  = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_SIMPLE
VERSION  = 1
VISUAL_MODE_COMPACT  = 3
VISUAL_MODE_USUAL  = 2

Methods

__construct()  : mixed
ConfigBuilder constructor.
allowDownload()  : self
allowEdit()  : self
allowRename()  : self
build()  : array<string|int, mixed>
getDocumentType()  : string
getMode()  : string
hideRightMenu()  : self
hideRulers()  : self
isEditMode()  : bool
isViewMode()  : bool
setBaseUrlToLogo()  : self
setCallbackUrl()  : self
setCompactHeader()  : self
setCompactToolbar()  : self
setDocumentSession()  : self
setDocumentUrl()  : self
setMode()  : self
setUser()  : self

Constants

DOCUMENT_TYPE_SLIDE

public mixed DOCUMENT_TYPE_SLIDE = 'slide'

REVIEW_DISPLAY_FINAL

public mixed REVIEW_DISPLAY_FINAL = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_FINAL

REVIEW_DISPLAY_MARKUP

public mixed REVIEW_DISPLAY_MARKUP = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_MARKUP

REVIEW_DISPLAY_ORIGINAL

public mixed REVIEW_DISPLAY_ORIGINAL = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_ORIGINAL

REVIEW_DISPLAY_SIMPLE

public mixed REVIEW_DISPLAY_SIMPLE = \Bitrix\Disk\Document\OnlyOffice\Editor\CustomizationBuilder::REVIEW_DISPLAY_SIMPLE

Methods

allowDownload()

public allowDownload(bool $allowed) : self
Parameters
$allowed : bool
Return values
self

allowEdit()

public allowEdit(bool $allowed) : self
Parameters
$allowed : bool
Return values
self

allowRename()

public allowRename(bool $allowed) : self
Parameters
$allowed : bool
Return values
self

build()

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

getDocumentType()

public getDocumentType() : string
Return values
string

hideRightMenu()

public hideRightMenu() : self
Return values
self
public setBaseUrlToLogo(Uri $url) : self
Parameters
$url : Uri
Return values
self

setCallbackUrl()

public setCallbackUrl(Uri $callbackUrl) : self
Parameters
$callbackUrl : Uri
Return values
self

setCompactHeader()

public setCompactHeader() : self
Return values
self

setCompactToolbar()

public setCompactToolbar() : self
Return values
self

setDocumentUrl()

public setDocumentUrl(Uri $documentUrl) : self
Parameters
$documentUrl : Uri
Return values
self

setMode()

public setMode(string $mode) : self
Parameters
$mode : string
Return values
self

setUser()

public setUser(User $user) : self
Parameters
$user : User
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results