Enums
Excel
Constant
Description
Some constants related to spreadsheets.
Usage
- Excel.Constant.MaxRowCount
Enum List
| Field | Value | Description |
|---|---|---|
| MaxRowCount | 1048576 | Maximum number of rows a spreadsheet can contain |
| MaxColCount | 16384 | Maximum number of columns a spreadsheet can contain |
| MaxColWidth | 2045 | Maximum column width |
| MaxRowHeight | 546 | Maximum row height |
| MaxImportImageSize | 2097152 | Maximum size of image that can be inserted (2MB) |
| DefRowHeight | 20 | Default row height |
| DefColWidth | 72 | Default column width |
BorderStyle
Description
Cell border line style.
Usage
- Excel.BorderStyle.ThinDotted
Enum List
| Field | Value | Description |
|---|---|---|
| ThinDotted | thindotted | Dotted line |
| ThinDashed | thindashed | Dashed line |
| ThinSolid | thinsolid | Solid line |
| ThickDotted | thickdotted | Thick dotted line |
| ThickDashed | thickdashed | Thick dashed line |
| ThickSolid | thicksolid | Thick solid line |
AlignmentStyle
Description
Text horizontal alignment.
Usage
- Excel.AlignmentStyle.Center
Enum List
| Field | Value | Description |
|---|---|---|
| Center | center | Horizontal center |
| Left | left | Horizontal left |
| Right | right | Horizontal right |
VerticalAlignmentStyle
Description
Text vertical alignment.
Usage
- Excel.VerticalAlignmentStyle.Middle
Enum List
| Field | Value | Description |
|---|---|---|
| Middle | middle | Vertical center |
| Top | top | Vertical top |
| Bottom | bottom | Vertical bottom |
FontStyle
Description
Font style.
Usage
- Excel.FontStyle.Bold
Enum List
| Field | Value | Description |
|---|---|---|
| Bold | bold | Bold |
| Italic | italic | Italic |
| Underline | underline | Underline |
| Normal | normal | Normal |
| Strikethrough | strikethrough | Strikethrough |
FontFamily
Description
Font family.
Usage
- Excel.FontFamily.Arial
Enum List
| Field | Value | Description |
|---|---|---|
| Arial | Arial | Font name |
| Comic Sans MS | Comic Sans MS | Font name |
| Courier New | Courier New | Font name |
| Georgia | Georgia | Font name |
| Lucida Sans Unicode | Lucida Sans Unicode | Font name |
| Tahoma | Tahoma | Font name |
| Times New Roman | Times New Roman | Font name |
| Trebuchet MS | Trebuchet MS | Font name |
| Verdana | Verdana | Font name |
| 宋体 | 宋体 | Font name |
| 黑体 | 黑体 | Font name |
| 微软雅黑 | 微软雅黑 | Font name |
| 隶书 | 隶书 | Font name |
| 幼圆 | 幼圆 | Font name |
| 华文细黑 | 华文细黑 | Font name |
| 华文楷体 | 华文楷体 | Font name |
| 华文宋体 | 华文宋体 | Font name |
| 华文新魏 | 华文新魏 | Font name |
| 华文隶书 | 华文隶书 | Font name |
| 等线 | 等线 | Font name |
| 仿宋 | 仿宋 | Font name |
| 楷体 | 楷体 | Font name |
| 方正舒体 | 方正舒体 | Font name |
| 方正姚体 | 方正姚体 | Font name |
PermissionType
Description
Type of data protection
Usage
Excel.PermissionType.ReadOnly
Enum List
| Field | Value | Description |
|---|---|---|
| ReadOnly | readOnly | This area is read-only for users without edit permission |
| Hide | hide | This area is hidden for users without edit permission |
NamedItemScope
Description
Scope of name object
Usage
Excel.NamedItemScope.Workbook
Enum List
| Field | Value | Description |
|---|---|---|
| Workbook | workbook | Workbook |
| Worksheet | worksheet | Worksheet |
XlAutoFillType
Description
Method of range fill
Usage
Excel.XlAutoFillType.xlFillDefault
Enum List
| Field | Value | Description |
|---|---|---|
| xlFillDefault | 0 | Determine the values and formats used to fill the target range |
| xlFillCopy | 1 | Copy the values and formats from the source range to the target range, repeating if necessary |
| xlFillSeries | 2 | Extend the values in the source range to the target range in series form (e.g., "1, 2" extends to "3, 4, 5"). Formats are copied from the source range to the target range, repeating if necessary |
DataValidationOperator
Description
Data validation operator
Usage
Excel.DataValidationOperator
Enum List
| Field | Value | Description |
|---|---|---|
| Between | 'between' | Between |
| EqualTo | 'equalTo' | Equal to |
| GreaterThan | 'greaterThan' | Greater than |
| GreaterThanOrEqualTo | 'greaterThanOrEqualTo' | Greater than or equal to |
| LessThan | 'lessThan' | Less than |
| LessThanOrEqualTo | 'lessThanOrEqualTo' | Less than or equal to |
| NotBetween | 'notBetween' | Not between |
| NotEqualTo | 'notEqualTo' | Not equal to |
CustomDataValidation
Description
Custom formula data validation
Usage
Excel.CustomDataValidation
Enum List
| Field | Value | Description |
|---|---|---|
| formula | string | Custom formula |
DateTimeDataValidation
Description
DateTime type data validation
Usage
Excel.DateTimeDataValidation
Enum List
| Field | Value | Description |
|---|---|---|
| formula1 | (string | number |
| formula2 | (string | number |
| operator | DataValidationOperator | Operator |
BasicDataValidation
Description Basic type data validation
Usage
Excel.BasicDataValidation
Enum List
| Field | Value | Description |
|---|---|---|
| formula1 | (string | number |
| formula2 | (string | number |
| operator | DataValidationOperator | Operator |
ListDataValidation
Description
List type data validation
Usage
Excel.ListDataValidation
Enum List
| Field | Value | Description |
|---|---|---|
| inCellDropDown | boolean | Whether dropdown is enabled |
| showOptionList | boolean | Type of dropdown list (false means sequence type, otherwise option type) |
| source | (string | Range) |
DataValidationRule
Description
Data validation rule
Usage
Excel.DataValidationRule
Enum List
| Field | Value | Description |
|---|---|---|
| custom | CustomDataValidation | Custom formula data validation |
| date | DateTimeDataValidation | Date data validation |
| decimal | BasicDataValidation | Numeric data validation |
| list | ListDataValidation | List data validation |
| textLength | BasicDataValidation | Text length data validation |
| time | DateTimeDataValidation | Time data validation |
| wholeNumber | BasicDataValidation | Integer data validation |
Word
WdUnderline
Description
Specifies the type of underline to apply
Usage
- Word.WdUnderline.wdUnderlineSingle
Enum List
| Field | Value | Description |
|---|---|---|
| wdUnderlineNone | 0 | No underline |
| wdUnderlineSingle | 1 | Single line. Default value |
WdColorIndex
Description
Specifies the font color to apply
Usage
- Word.WdColorIndex.wdBlack
Enum List
| Field | Value | Description |
|---|---|---|
| wdByAuthor | -1 | Color defined by document author |
| wdAuto | 0 | Auto color. Default value; usually black |
| wdBlack | 1 | Black |
| wdBlue | 2 | Blue |
| wdTurquoise | 3 | Turquoise |
| wdBrightGreen | 4 | Bright green |
| wdPink | 5 | Pink |
| wdRed | 6 | Red |
| wdYellow | 7 | Yellow |
| wdWhite | 8 | White |
| wdDarkBlue | 9 | Dark blue |
| wdTeal | 10 | Teal |
| wdGreen | 11 | Green |
| wdViolet | 12 | Violet |
| wdDarkRed | 13 | Dark red |
| wdDarkYellow | 14 | Dark yellow |
| wdGray50 | 15 | 50% gray shading |
| wdGray25 | 16 | 25% gray shading |
| wdOrigin | 17 | Orange |
| wdGreenLight | 18 | Light green |
WdReplace
Description
Specifies the number of replacements to make when using "Find and Replace".
Usage
- Word.WdReplace.wdReplaceAll
Enum List
| Field | Value | Description |
|---|---|---|
| wdReplaceAll | 2 | Replace all matches |
| wdReplaceNone | 0 | Do not replace any matches |
| wdReplaceOne | 1 | Replace the first match encountered |
ScopeType
Description
Get the scope type of text
Usage
- Word.ScopeType.PARAGRAPH
Enum List
| Field | Value | Description |
|---|---|---|
| PARAGRAPH | 'paragraph' | Get text within paragraph scope |
| SENTENCE | 'sentence' | Get text within sentence scope |
DirectionType
Description
Direction
Usage
- Word.DirectionType.SELF
Enum List
| Field | Value | Description |
|---|---|---|
| SELF | 'self' | Current paragraph or sentence |
| NEXTSIBLING | 'nextSibling' | Next paragraph or sentence |
RevisionType
Description
Revision type
Usage
- Word.RevisionType.Insert
Enum List
| Field | Value | Description |
|---|---|---|
| Insert | 'ins' | Insert |
| Delete | 'del' | Delete |
| ParagraphProperty | 'pPrChange' | Paragraph property changed |
PositionType
Description
Position type
Usage
- Word.PositionType.Paragraph
Enum List
| Field | Value | Description |
|---|---|---|
| Paragraph | 1 | Position in paragraph |
| Bookmark | 2 | Position of bookmark |
| PermMark | 3 | Position of editable area |
| Row | 4 | Position within table row |
LocationRelation
JSSDK: 1.2.1、zOffice2022.3 FP1 support
Description
Position relationship between two Ranges
Usage
- Word.LocationRelation.equal
Enum List
| Field | Value | Description |
|---|---|---|
| before | 'before' | range1 is before range2, no overlap but including end-to-end connection |
| containsStart | 'containsStart' | range1 is before range2, partially overlapping |
| equal | 'equal' | Completely overlapping |
| outside | 'outside' | range1 is contained within range2, including end-to-end coincidence |
| containsEnd | 'containsEnd' | range1 is after range2, partially overlapping |
| inside | 'inside' | range1 contains range2, including end-to-end coincidence |
| behind | 'behind' | range1 is after range2, no overlap but including end-to-end connection |
MarkType
JSSDK: 1.2.21、zOffice2022.3 FP2 hotfix1 support
Description
Get the type of mark
Usage
- Word.MarkType.PERMMARK
Enum List
| Field | Value | Description |
|---|---|---|
| BOOKMARK | 'book' | Bookmark type |
| PERMMARK | 'perm' | Protected editable area type |
WdWrapType
JSSDK: 1.3.1、zOffice V6.0 FP1 support
Description
Text wrapping type for non-embedded images
Usage
- Word.WdWrapType.wdWrapNone
Enum List
| Field | Value | Description |
|---|---|---|
| wdWrapNone | 3 | This is the default value of WdWrapType, same as wdWrapFront |
| wdWrapFront | 3 | Place image in front of text |
| wdWrapBehind | 5 | Place image behind text |
| wdWrapInline | 7 | Embed image into text |
WdRevisionsView
JSSDK: 1.3.23、zOffice V6.0 FP2 hotfix 3 support
Description
Specifies whether Word displays the original version of the document or the version with revisions and formatting changes applied
Usage
- Word.WdRevisionsView.wdRevisionsViewFinal
Enum List
| Field | Value | Description |
|---|---|---|
| wdRevisionsViewFinal | 0 | Display document with format and content changes applied |
| wdRevisionsViewOriginal | 1 | Display document before changes were made |
WdBuiltinStyle
JSSDK: 1.4.0、zOffice V6.1 support
Description
Specifies built-in Word styles
Usage
- Word.WdBuiltinStyle.wdStyleHeading1
Enum List
| Field | Value | Description |
|---|---|---|
| wdStyleNormal | -1 | Normal text |
| wdStyleHeading1 | -2 | Heading 1 |
| wdStyleHeading2 | -3 | Heading 2 |
| wdStyleHeading3 | -4 | Heading 3 |
| wdStyleHeading4 | -5 | Heading 4 |
| wdStyleHeading5 | -6 | Heading 5 |
| wdStyleHeading6 | -7 | Heading 6 |
| wdStyleHeading7 | -8 | Heading 7 |
| wdStyleHeading8 | -9 | Heading 8 |
| wdStyleHeading9 | -10 | Heading 9 |
| wdStyleTitle | -63 | Title |
| wdStyleSubtitle | -75 | Subtitle |
WdOutlineLevel
JSSDK: 1.4.0、zOffice V6.1 support
Description
Specifies the outline level to apply to a paragraph.
Usage
- Word.WdOutlineLevel.wdOutlineLevel1
Enum List
| Field | Value | Description |
|---|---|---|
| wdOutlineLevel1 | 1 | Outline level 1 |
| wdOutlineLevel2 | 2 | Outline level 2 |
| wdOutlineLevel3 | 3 | Outline level 3 |
| wdOutlineLevel4 | 4 | Outline level 4 |
| wdOutlineLevel5 | 5 | Outline level 5 |
| wdOutlineLevel6 | 6 | Outline level 6 |
| wdOutlineLevel7 | 7 | Outline level 7 |
| wdOutlineLevel8 | 8 | Outline level 8 |
| wdOutlineLevel9 | 9 | Outline level 9 |
| wdOutlineLevelBodyText | 10 | No outline level |
WdHeaderFooterIndex
JSSDK: 1.4.1、zOffice V7.0 FP1 support
Description
Returns the specified header or footer in the document or section.
Usage
- Word.WdHeaderFooterIndex.wdHeaderFooterPrimary
Enum List
| Field | Value | Description |
|---|---|---|
| wdHeaderFooterPrimary | 1 | Returns the header or footer on all pages of the document or section except the first page (this first page is not the visual first page, but the first page after setting different first page, when not set, all pages are non-first pages) |
| wdHeaderFooterFirstPage | 2 | Returns the first header or footer in the document or section (first page after setting different first page) |
| wdHeaderFooterEvenPages | 3 | Returns all headers or footers on even pages (even pages after setting different odd and even pages) |
MarksIdentifyRule
JSSDK: 1.7.01、zOffice V7.2 hotfix1 support
Description
Intelligent bookmark identification rule
Usage
- Word.MarksIdentifyRule.TEXT
Enum List
| Field | Value | Description |
|---|---|---|
| TEXT | 'text' | Identify underlined areas with text content |
| EMPTY | 'empty' | Identify underlined areas with empty content |
MarksGenerateNameRule
JSSDK: 1.7.01、zOffice V7.2 hotfix1 support
Description
Intelligent bookmark naming rule
Usage
- Word.MarksGenerateNameRule.ABOVE
Enum List
| Field | Value | Description |
|---|---|---|
| ABOVE | 'above' | Name using text content above underline |
| BEFORE | 'before' | Name using text content before underline |
ProtectionType
JSSDK: 1.7.2、zOffice V7.2 FP1 support
Description
Document protection type enum value
Usage
- Word.ProtectionType.FormEntry
Enum List
| Field | Value | Description |
|---|---|---|
| NoProtection | 0 | No protection type |
| FormEntry | 1 | Form entry |
| Revision | 2 | Revision protection |
| EditArea | 4 | Area editing |
| Comments | 8 | Comment mode |
DocPermission
Description
Default permission for the entire document when the document is in area editing protection state
Usage
- Word.DocPermission.Editable
Enum List
| Field | Value | Description |
|---|---|---|
| ReadOnly | 'readOnly' | Entire document is read-only |
| Editable | 'editable' | Entire document is editable |
| None | 'none' | Document has not enabled area editing protection |
PermissionType
Description
Specifies the permission of the current user for editable areas
Usage
- Word.PermissionType.Editable
Enum List
| Field | Value | Description |
|---|---|---|
| ReadOnly | 'readOnly' | Only visible |
| Editable | 'editable' | Editable |
| Hidden | 'hidden' | Not visible |
PowerPoint
JSSDK: 1.7.0、zOffice V7.2 support
DocViewType
Description
Current operation type.
Usage
- PowerPoint.DocViewType.SlideChange
| Field | Value | Description |
|---|---|---|
| SlideChange | 0 | Page modification |
| Play | 1 | Playing |
DocViewPlayAction
Description
Current operation action.
Usage
- PowerPoint.DocViewPlayAction.forward
| Field | Value | Description |
|---|---|---|
| forward | 0 | Forward |
| backward | 1 | Backward |
| effectFinish | 2 | Response after finishing current animation or waiting for animation to end when animation exists |