Represents a paragraph of text in a OneNote page.
| Name |
Type |
Access |
Description |
| alignment |
Alignment |
read-write |
Text alignment for this Paragraph (e.g. left, right or center). |
| author |
String |
read-write |
The original author of this Paragraph. |
| authorInitials |
String |
read-write |
The initials of the original author of this Paragraph. |
| bold |
Bool |
write-only |
Whether the text in this Paragraph is bold or not. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| bulletFontColor |
Color |
read-write |
The color for the bullet for this Paragraph. |
| bulletFontSize |
Numeric |
read-write |
The font size for the bullet for this Paragraph. |
| bulletType |
Numeric |
read-write |
The type of the bullet for this Paragraph. See Bulleted and numbered lists for more information. |
| collapsed |
Bool |
read-write |
Whether this Paragraph is collapsed or not. |
| content |
Mixed |
read-only |
The content stored in this Paragraph. To find out what type of object is stored in this property, check the contentType property:The value is the same as the value of texts property if the contentType property is text. |
| contentType |
ContentType |
read-only |
The type of content stored in this Paragraph. |
| creationTime |
DateTime |
read-write |
The date and time this Paragraph is originally created. |
| fontColor |
Color |
write-only |
The text color for this Paragraph. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| fontName |
String |
write-only |
The name of the font for this Paragraph. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| fontSize |
Numeric |
write-only |
The font size for this Paragraph. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| highlightColor |
Color |
write-only |
The highlight color for this Paragraph. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| hyperlink |
String |
read-only |
The hyperlink to this Paragraph. |
| indent |
Numeric |
read-write |
The indent amount for this Paragraph, relative to its parent Outline or Cell. An unindented Paragraph has an indent of 0. |
| index |
Numeric |
read-only |
The number of Paragraphs before this Paragraph within its Outline or Cell. The paragraph must be in an Outline or a Cell, otherwise this property has the value of 0. |
| isPartOfBulletedList |
Bool |
read-write |
Whether this Paragraph is part of a bulleted list or not. See Bulleted and numbered lists for more information. |
| isPartOfList |
Bool |
read-only |
Whether this Paragraph is part of a bulleted or numbered list or not. See Bulleted and numbered lists for more information. |
| isPartOfNumberedList |
Bool |
read-write |
Whether this Paragraph is part of a numbered list or not. See Bulleted and numbered lists for more information. |
| italic |
Bool |
write-only |
Whether the text in this Paragraph is italicized or not. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| lang |
String |
write-only |
The language the text in this Paragraph is writte in. This property is write-only as there may be text with different languages in the paragraph. Setting this property will apply its value to the whole paragraph. |
| lastModifiedBy |
String |
read-write |
The person who last modified this Paragraph. |
| lastModifiedByInitials |
String |
read-write |
The initials of the person who last modified this Paragraph. |
| lastModifiedTime |
DateTime |
read-write |
The date and time of the last modification to this Paragraph. |
| listAlignment |
Alignment |
read-write |
The text alignment for the numbered list for this Paragraph (left vs right). The default alignment value is "right". |
| listSpacing |
Numeric |
read-write |
The space between the numbered list and the paragraph in points. The default spacing amount is 7.2 points (0.1 inches). |
| numberBold |
Bool |
read-write |
Whether the numbered list for this Paragraph is bold or not. |
| numberFont |
String |
read-write |
The name of the font face for the numbered list for this Paragraph. |
| numberFontColor |
Color |
read-write |
The color for the numbered list for this Paragraph. |
| numberFontSize |
Numeric |
read-write |
The size of the font for the numbered list for this Paragraph. |
| numberFormat |
String |
read-write |
The number format for the numbered list for this Paragraph. See Bulleted and numbered lists for more information. |
| numberItalic |
Bool |
read-write |
Whether the numbered list for this Paragraph is italicized or not. |
| numberLanguage |
String |
read-write |
The language for the numbered list for this Paragraph. |
| numberSequence |
Numeric |
read-write |
The number sequence for the numbered list for this Paragraph. See Bulleted and numbered lists for more information. |
| numberText |
String |
read-only |
The text for the numbered list for this Paragraph. |
| objectId |
String |
read-write |
The unique identifier of this Paragraph. |
| rtl |
Bool |
read-write |
Whether this Paragraph is right-to-left aligned or not. |
| selection |
Selection |
read-write |
Whether this Paragraph is fully or partially selected or not. |
| spaceAfter |
Numeric |
read-write |
The amount of space after this Paragraph in points. This property requires OneNote 2013 or above. |
| spaceBefore |
Numeric |
read-write |
The amount of space before this Paragraph in points. This property requires OneNote 2013 or above. |
| spaceBetween |
Numeric |
read-write |
The amount of space between the lines of this Paragraph in points. This property requires OneNote 2013 or above. |
| strikethrough |
Bool |
write-only |
Whether the text in this Paragraph is striked through or not. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| style |
ParagraphStyle |
read-write |
The style of this Paragraph. |
| supersub |
SuperSub |
write-only |
Whether the text in this Paragraph is superscript/subscript or not. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
| tags |
Array<Tag> |
read-only |
List of tags associated with this Paragraph. |
| text |
String |
read-write |
The text of this Paragraph. |
| text_numeric |
Numeric |
read-write |
The text of this Paragraph interpreted as a numerical value. Useful to apply arithmetic operations on it. |
| texts |
Array<Text> |
read-only |
List of Text objects within this Paragraph. |
| type |
ObjectType |
read-only |
Type of this object. Always has the value of "Paragraph". |
| underline |
Bool |
write-only |
Whether the text in this Paragraph is underlined or not. This property is write-only as there may be text with different formatting in the paragraph. Setting this property will apply its value to the whole paragraph. |
Following properties are deprecated. Do not use these in new macros. See descriptions below on what to use instead.
| Name |
Type |
Access |
Description |
| tagCompleted |
Bool |
read-write |
Whether the first tag associated with this Paragraph is completed (checked) or not. This property is deprecated. Use tags property instead. |
| tagCompletionDate |
DateTime |
read-write |
The date and time of completion of the first tag associated with this Paragraph. This property is deprecated. Use tags property instead. |
| tagCreationDate |
DateTime |
read-write |
The date and time of creation of the first tag associated with this Paragraph. This property is deprecated. Use tags property instead. |
| tagDisabled |
Bool |
read-write |
Whether the first tag associated with this Paragraph is disabled (dimmed) or not. This property is deprecated. Use tags property instead. |
| tagFontColor |
Color |
read-only |
The font color for the first tag associated with this Paragraph for tags that use formatting instead of a symbol. This property is deprecated. Use tags property instead. |
| tagHighlightColor |
Color |
read-only |
The highlight color for the first tag associated with this Paragraph for tags that use formatting instead of a symbol. This property is deprecated. Use tags property instead. |
| tagName |
String |
read-only |
The name of the first tag associated with this Paragraph. This property is deprecated. Use tags property instead. |
| tagSymbol |
Numeric |
read-only |
The symbol of the first tag associated with this Paragraph. This property is deprecated. Use tags property instead. |
| tagType |
Numeric |
read-only |
The type of the first tag associated with this Paragraph. This property is deprecated. Use tags property instead. |