Section Not Found - ONLYOFFICE Api Documentation

DocSpace
Docs
Workspace
- API Backend
- For hosting providers

TRY NEW VERSION

Get Started

Overview

Office API

Text document API
Spreadsheet API
- Api
  - AddComment
  - AddCustomFunction
  - AddDefName
  - AddSheet
  - attachEvent
  - ClearCustomFunctions
  - CreateBlipFill
  - CreateBullet
  - CreateColorByName
  - CreateColorFromRGB
  - CreateGradientStop
  - CreateLinearGradientFill
  - CreateNewHistoryPoint
  - CreateNoFill
  - CreateNumbering
  - CreateParagraph
  - CreatePatternFill
  - CreatePresetColor
  - CreateRadialGradientFill
  - CreateRGBColor
  - CreateRun
  - CreateSchemeColor
  - CreateSolidFill
  - CreateStroke
  - CreateTextPr
  - detachEvent
  - Format
  - GetActiveSheet
  - GetAllComments
  - GetCommentById
  - GetComments
  - GetDefName
  - GetFreezePanesType
  - GetFullName
  - GetLocale
  - GetMailMergeData
  - GetRange
  - GetReferenceStyle
  - GetSelection
  - GetSheet
  - GetSheets
  - GetThemesColors
  - GetWorksheetFunction
  - Intersect
  - RecalculateAllFormulas
  - RemoveCustomFunction
  - ReplaceTextSmart
  - Save
  - SetFreezePanesType
  - SetLocale
  - SetReferenceStyle
  - SetThemeColors
  - onWorksheetChange
- ApiAreas
  - GetCount
  - GetItem
  - GetParent
- ApiBullet
  - GetClassType
- ApiCharacters
  - Delete
  - GetCaption
  - GetCount
  - GetFont
  - GetParent
  - GetText
  - Insert
  - SetCaption
  - SetText
- ApiChart
  - AddSeria
  - ApplyChartStyle
  - GetClassType
  - RemoveSeria
  - SetAxieNumFormat
  - SetCatFormula
  - SetDataPointFill
  - SetDataPointOutLine
  - SetHorAxisLablesFontSize
  - SetHorAxisMajorTickMark
  - SetHorAxisMinorTickMark
  - SetHorAxisOrientation
  - SetHorAxisTickLabelPosition
  - SetHorAxisTitle
  - SetLegendFill
  - SetLegendFontSize
  - SetLegendOutLine
  - SetLegendPos
  - SetMajorHorizontalGridlines
  - SetMajorVerticalGridlines
  - SetMarkerFill
  - SetMarkerOutLine
  - SetMinorHorizontalGridlines
  - SetMinorVerticalGridlines
  - SetPlotAreaFill
  - SetPlotAreaOutLine
  - SetSeriaName
  - SetSeriaValues
  - SetSeriaXValues
  - SetSeriesFill
  - SetSeriesOutLine
  - SetShowDataLabels
  - SetShowPointDataLabel
  - SetTitle
  - SetTitleFill
  - SetTitleOutLine
  - SetVerAxisOrientation
  - SetVerAxisTitle
  - SetVertAxisLablesFontSize
  - SetVertAxisMajorTickMark
  - SetVertAxisMinorTickMark
  - SetVertAxisTickLabelPosition
- ApiColor
  - GetClassType
  - GetRGB
- ApiComment
  - AddReply
  - Delete
  - GetAuthorName
  - GetClassType
  - GetId
  - GetQuoteText
  - GetRepliesCount
  - GetReply
  - GetText
  - GetTime
  - GetTimeUTC
  - GetUserId
  - IsSolved
  - RemoveReplies
  - SetAuthorName
  - SetSolved
  - SetText
  - SetTime
  - SetTimeUTC
  - SetUserId
- ApiCommentReply
  - GetAuthorName
  - GetClassType
  - GetText
  - GetTime
  - GetTimeUTC
  - GetUserId
  - SetAuthorName
  - SetText
  - SetTime
  - SetTimeUTC
  - SetUserId
- ApiDocument
  - AddElement
  - GetElement
  - GetElementsCount
  - Push
  - RemoveAllElements
  - RemoveElement
- ApiDocumentContent
  - AddElement
  - GetClassType
  - GetElement
  - GetElementsCount
  - Push
  - RemoveAllElements
  - RemoveElement
- ApiDrawing
  - GetClassType
  - GetHeight
  - GetLockValue
  - GetWidth
  - SetLockValue
  - SetPosition
  - SetSize
- ApiFill
  - GetClassType
- ApiFont
  - GetBold
  - GetColor
  - GetItalic
  - GetName
  - GetParent
  - GetSize
  - GetStrikethrough
  - GetSubscript
  - GetSuperscript
  - GetUnderline
  - SetBold
  - SetColor
  - SetItalic
  - SetName
  - SetSize
  - SetStrikethrough
  - SetSubscript
  - SetSuperscript
  - SetUnderline
- ApiFreezePanes
  - FreezeAt
  - FreezeColumns
  - FreezeRows
  - GetLocation
- ApiGradientStop
  - GetClassType
- ApiImage
  - GetClassType
- ApiName
  - Delete
  - GetName
  - GetRefersTo
  - GetRefersToRange
  - SetName
  - SetRefersTo
- ApiOleObject
  - GetApplicationId
  - GetClassType
  - GetData
  - SetApplicationId
  - SetData
- ApiParagraph
  - AddElement
  - AddLineBreak
  - AddTabStop
  - AddText
  - Copy
  - Delete
  - GetClassType
  - GetElement
  - GetElementsCount
  - GetIndFirstLine
  - GetIndLeft
  - GetIndRight
  - GetJc
  - GetNext
  - GetParaPr
  - GetPrevious
  - GetSpacingAfter
  - GetSpacingBefore
  - GetSpacingLineRule
  - GetSpacingLineValue
  - RemoveAllElements
  - RemoveElement
  - SetBullet
  - SetIndFirstLine
  - SetIndLeft
  - SetIndRight
  - SetJc
  - SetSpacingAfter
  - SetSpacingBefore
  - SetSpacingLine
  - SetTabs
- ApiParaPr
  - GetClassType
  - GetIndFirstLine
  - GetIndLeft
  - GetIndRight
  - GetJc
  - GetSpacingAfter
  - GetSpacingBefore
  - GetSpacingLineRule
  - GetSpacingLineValue
  - SetBullet
  - SetIndFirstLine
  - SetIndLeft
  - SetIndRight
  - SetJc
  - SetSpacingAfter
  - SetSpacingBefore
  - SetSpacingLine
  - SetTabs
- ApiPresetColor
  - GetClassType
- ApiProtectedRange
  - AddUser
  - DeleteUser
  - GetAllUsers
  - GetUser
  - SetAnyoneType
  - SetRange
  - SetTitle
- ApiProtectedRangeUserInfo
  - GetId
  - GetName
  - GetType
- ApiRange
  - AddComment
  - AutoFit
  - Clear
  - Copy
  - Cut
  - Delete
  - End
  - Find
  - FindNext
  - FindPrevious
  - ForEach
  - GetAddress
  - GetAreas
  - GetCells
  - GetCharacters
  - GetClassType
  - GetCol
  - GetCols
  - GetColumnWidth
  - GetComment
  - GetCount
  - GetDefName
  - GetFillColor
  - GetFormula
  - GetHidden
  - GetNumberFormat
  - GetOrientation
  - GetRow
  - GetRowHeight
  - GetRows
  - GetText
  - GetValue
  - GetValue2
  - GetWorksheet
  - GetWrapText
  - Insert
  - Merge
  - Paste
  - PasteSpecial
  - Replace
  - Select
  - SetAlignHorizontal
  - SetAlignVertical
  - SetBold
  - SetBorders
  - SetColumnWidth
  - SetFillColor
  - SetFontColor
  - SetFontName
  - SetFontSize
  - SetHidden
  - SetItalic
  - SetNumberFormat
  - SetOffset
  - SetOrientation
  - SetRowHeight
  - SetSort
  - SetStrikeout
  - SetUnderline
  - SetValue
  - SetWrap
  - UnMerge
- ApiRGBColor
  - GetClassType
- ApiRun
  - AddLineBreak
  - AddTabStop
  - AddText
  - ClearContent
  - Copy
  - Delete
  - GetBold
  - GetCaps
  - GetClassType
  - GetDoubleStrikeout
  - GetFill
  - GetFontFamily
  - GetFontNames
  - GetFontSize
  - GetItalic
  - GetOutLine
  - GetSmallCaps
  - GetSpacing
  - GetStrikeout
  - GetTextFill
  - GetTextPr
  - GetUnderline
  - RemoveAllElements
  - SetBold
  - SetCaps
  - SetColor
  - SetDoubleStrikeout
  - SetFill
  - SetFontFamily
  - SetFontSize
  - SetHighlight
  - SetItalic
  - SetLanguage
  - SetOutLine
  - SetPosition
  - SetShd
  - SetSmallCaps
  - SetSpacing
  - SetStrikeout
  - SetStyle
  - SetTextFill
  - SetTextPr
  - SetUnderline
  - SetVertAlign
- ApiSchemeColor
  - GetClassType
- ApiShape
  - GetClassType
  - GetContent
  - GetDocContent
  - SetPaddings
  - SetVerticalTextAlign
- ApiStroke
  - GetClassType
- ApiTextPr
  - GetBold
  - GetCaps
  - GetClassType
  - GetDoubleStrikeout
  - GetFill
  - GetFontFamily
  - GetFontSize
  - GetItalic
  - GetOutLine
  - GetSmallCaps
  - GetSpacing
  - GetStrikeout
  - GetTextFill
  - GetUnderline
  - SetBold
  - SetCaps
  - SetDoubleStrikeout
  - SetFill
  - SetFontFamily
  - SetFontSize
  - SetItalic
  - SetOutLine
  - SetSmallCaps
  - SetSpacing
  - SetStrikeout
  - SetTextFill
  - SetUnderline
  - SetVertAlign
- ApiUniColor
  - GetClassType
- ApiWorksheet
  - AddChart
  - AddDefName
  - AddImage
  - AddOleObject
  - AddProtectedRange
  - AddShape
  - AddWordArt
  - Delete
  - FormatAsTable
  - GetActiveCell
  - GetAllCharts
  - GetAllDrawings
  - GetAllImages
  - GetAllOleObjects
  - GetAllProtectedRanges
  - GetAllShapes
  - GetBottomMargin
  - GetCells
  - GetCols
  - GetComments
  - GetDefName
  - GetDefNames
  - GetFreezePanes
  - GetIndex
  - GetLeftMargin
  - GetName
  - GetPageOrientation
  - GetPrintGridlines
  - GetPrintHeadings
  - GetProtectedRange
  - GetRange
  - GetRangeByNumber
  - GetRightMargin
  - GetRows
  - GetSelection
  - GetTopMargin
  - GetUsedRange
  - GetVisible
  - Move
  - Paste
  - ReplaceCurrentImage
  - SetActive
  - SetBottomMargin
  - SetColumnWidth
  - SetDisplayGridlines
  - SetDisplayHeadings
  - SetHyperlink
  - SetLeftMargin
  - SetName
  - SetPageOrientation
  - SetPrintGridlines
  - SetPrintHeadings
  - SetRightMargin
  - SetRowHeight
  - SetTopMargin
  - SetVisible
- ApiWorksheetFunction
  - ABS
  - ACCRINT
  - ACCRINTM
  - ACOS
  - ACOSH
  - ACOT
  - ACOTH
  - AGGREGATE
  - AMORDEGRC
  - AMORLINC
  - AND
  - ARABIC
  - ASC
  - ASIN
  - ASINH
  - ATAN
  - ATAN2
  - ATANH
  - AVEDEV
  - AVERAGE
  - AVERAGEA
  - AVERAGEIF
  - AVERAGEIFS
  - BASE
  - BESSELI
  - BESSELJ
  - BESSELK
  - BESSELY
  - BETADIST
  - BETAINV
  - BETA_DIST
  - BETA_INV
  - BIN2DEC
  - BIN2HEX
  - BIN2OCT
  - BINOMDIST
  - BINOM_DIST
  - BINOM_DIST_RANGE
  - BINOM_INV
  - BITAND
  - BITLSHIFT
  - BITOR
  - BITRSHIFT
  - BITXOR
  - CEILING
  - CEILING_MATH
  - CEILING_PRECISE
  - CHAR
  - CHIDIST
  - CHIINV
  - CHISQ_DIST
  - CHISQ_DIST_RT
  - CHISQ_INV
  - CHISQ_INV_RT
  - CHITEST
  - CHOOSE
  - CLEAN
  - CODE
  - COLUMNS
  - COMBIN
  - COMBINA
  - COMPLEX
  - CONCATENATE
  - CONFIDENCE
  - CONFIDENCE_NORM
  - CONFIDENCE_T
  - CONVERT
  - COS
  - COSH
  - COT
  - COTH
  - COUNT
  - COUNTA
  - COUNTBLANK
  - COUNTIF
  - COUNTIFS
  - COUPDAYBS
  - COUPDAYS
  - COUPDAYSNC
  - COUPNCD
  - COUPNUM
  - COUPPCD
  - CRITBINOM
  - CSC
  - CSCH
  - CUMIPMT
  - CUMPRINC
  - DATE
  - DATEVALUE
  - DAVERAGE
  - DAY
  - DAYS
  - DAYS360
  - DB
  - DCOUNT
  - DCOUNTA
  - DDB
  - DEC2BIN
  - DEC2HEX
  - DEC2OCT
  - DECIMAL
  - DEGREES
  - DELTA
  - DEVSQ
  - DGET
  - DISC
  - DMAX
  - DMIN
  - DOLLAR
  - DOLLARDE
  - DOLLARFR
  - DPRODUCT
  - DSTDEV
  - DSTDEVP
  - DSUM
  - DURATION
  - DVAR
  - DVARP
  - ECMA_CEILING
  - EDATE
  - EFFECT
  - EOMONTH
  - ERF
  - ERFC
  - ERFC_PRECISE
  - ERF_PRECISE
  - ERROR_TYPE
  - EVEN
  - EXACT
  - EXP
  - EXPONDIST
  - EXPON_DIST
  - FACT
  - FACTDOUBLE
  - FALSE
  - FDIST
  - FIND
  - FINDB
  - FINV
  - FISHER
  - FISHERINV
  - FIXED
  - FLOOR
  - FLOOR_MATH
  - FLOOR_PRECISE
  - FORECAST_ETS
  - FORECAST_ETS_CONFINT
  - FORECAST_ETS_SEASONALITY
  - FORECAST_ETS_STAT
  - FREQUENCY
  - FV
  - FVSCHEDULE
  - F_DIST
  - F_DIST_RT
  - F_INV
  - F_INV_RT
  - GAMMA
  - GAMMADIST
  - GAMMAINV
  - GAMMALN
  - GAMMALN_PRECISE
  - GAMMA_DIST
  - GAMMA_INV
  - GAUSS
  - GCD
  - GEOMEAN
  - GESTEP
  - GROWTH
  - HARMEAN
  - HEX2BIN
  - HEX2DEC
  - HEX2OCT
  - HLOOKUP
  - HOUR
  - HYPERLINK
  - HYPGEOMDIST
  - HYPGEOM_DIST
  - IF
  - IFERROR
  - IFNA
  - IMABS
  - IMAGINARY
  - IMARGUMENT
  - IMCONJUGATE
  - IMCOS
  - IMCOSH
  - IMCOT
  - IMCSC
  - IMCSCH
  - IMDIV
  - IMEXP
  - IMLN
  - IMLOG10
  - IMLOG2
  - IMPOWER
  - IMPRODUCT
  - IMREAL
  - IMSEC
  - IMSECH
  - IMSIN
  - IMSINH
  - IMSQRT
  - IMSUB
  - IMSUM
  - IMTAN
  - INDEX
  - INT
  - INTRATE
  - IPMT
  - IRR
  - ISERR
  - ISERROR
  - ISEVEN
  - ISFORMULA
  - ISLOGICAL
  - ISNA
  - ISNONTEXT
  - ISNUMBER
  - ISODD
  - ISOWEEKNUM
  - ISO_CEILING
  - ISPMT
  - ISREF
  - ISTEXT
  - KURT
  - LARGE
  - LCM
  - LEFT
  - LEFTB
  - LEN
  - LENB
  - LINEST
  - LN
  - LOG
  - LOG10
  - LOGEST
  - LOGINV
  - LOGNORMDIST
  - LOGNORM_DIST
  - LOGNORM_INV
  - LOOKUP
  - LOWER
  - MATCH
  - MAX
  - MAXA
  - MDURATION
  - MEDIAN
  - MID
  - MIDB
  - MIN
  - MINA
  - MINUTE
  - MIRR
  - MOD
  - MONTH
  - MROUND
  - MULTINOMIAL
  - MUNIT
  - N
  - NA
  - NEGBINOMDIST
  - NEGBINOM_DIST
  - NETWORKDAYS
  - NETWORKDAYS_INTL
  - NOMINAL
  - NORMDIST
  - NORMINV
  - NORMSDIST
  - NORMSINV
  - NORM_DIST
  - NORM_INV
  - NORM_S_DIST
  - NORM_S_INV
  - NOT
  - NOW
  - NPER
  - NPV
  - NUMBERVALUE
  - OCT2BIN
  - OCT2DEC
  - OCT2HEX
  - ODD
  - ODDFPRICE
  - ODDFYIELD
  - ODDLPRICE
  - ODDLYIELD
  - OR
  - PDURATION
  - PERCENTILE
  - PERCENTILE_EXC
  - PERCENTILE_INC
  - PERCENTRANK
  - PERCENTRANK_EXC
  - PERCENTRANK_INC
  - PERMUT
  - PERMUTATIONA
  - PHI
  - PI
  - PMT
  - POISSON
  - POISSON_DIST
  - POWER
  - PPMT
  - PRICE
  - PRICEDISC
  - PRICEMAT
  - PRODUCT
  - PROPER
  - PV
  - QUARTILE
  - QUARTILE_EXC
  - QUARTILE_INC
  - QUOTIENT
  - RADIANS
  - RAND
  - RANDBETWEEN
  - RANK
  - RANK_AVG
  - RANK_EQ
  - RATE
  - RECEIVED
  - REPLACE
  - REPLACEB
  - REPT
  - RIGHT
  - RIGHTB
  - ROMAN
  - ROUND
  - ROUNDDOWN
  - ROUNDUP
  - ROWS
  - RRI
  - SEARCH
  - SEARCHB
  - SEC
  - SECH
  - SECOND
  - SERIESSUM
  - SHEET
  - SHEETS
  - SIGN
  - SIN
  - SINH
  - SKEW
  - SKEW_P
  - SLN
  - SMALL
  - SQRT
  - SQRTPI
  - STANDARDIZE
  - STDEV
  - STDEVA
  - STDEVP
  - STDEVPA
  - STDEV_P
  - STDEV_S
  - SUBSTITUTE
  - SUBTOTAL
  - SUM
  - SUMIF
  - SUMIFS
  - SUMSQ
  - SYD
  - T
  - TAN
  - TANH
  - TBILLEQ
  - TBILLPRICE
  - TBILLYIELD
  - TDIST
  - TEXT
  - TIME
  - TIMEVALUE
  - TINV
  - TODAY
  - TRANSPOSE
  - TREND
  - TRIM
  - TRIMMEAN
  - TRUE
  - TRUNC
  - TYPE
  - T_DIST
  - T_DIST_2T
  - T_DIST_RT
  - T_INV
  - T_INV_2T
  - UNICHAR
  - UNICODE
  - UPPER
  - VALUE
  - VAR
  - VARA
  - VARP
  - VARPA
  - VAR_P
  - VAR_S
  - VDB
  - VLOOKUP
  - WEEKDAY
  - WEEKNUM
  - WEIBULL
  - WEIBULL_DIST
  - WORKDAY
  - WORKDAY_INTL
  - XIRR
  - XNPV
  - XOR
  - YEAR
  - YEARFRAC
  - YIELD
  - YIELDDISC
  - YIELDMAT
  - ZTEST
  - Z_TEST
Presentation API
Form API
- Api
- ApiDocument
  - InsertTextForm
Simple types
Builder samples

More information

Changelog

Section Not Found

You can search in documentation

Get information

Blog for developers
For contributors
Legal notice

Get help

Forum
Code on GitHub
Installation guides
Support contact form

© Ascensio System SIA 2024. All rights reserved