- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
SplitOptions
DsPdfJS API / SplitOptions
Class: SplitOptions
Represents the options for text splitting.
Extends
Constructors
Constructor
new SplitOptions(
properties?):SplitOptions
Creates a new SplitOptions object with specified properties.
Parameters
properties?
The options for text splitting.
Returns
SplitOptions
Overrides
ObjectBase.constructor
Constructor
new SplitOptions(
baseLayout,properties?):SplitOptions
Creates a new SplitOptions based on properties of an existing Layout.
Parameters
baseLayout
The Layout object used as the base for the new SplitOptions.
properties?
The settings overriding properties of the base Layout.
Returns
SplitOptions
Overrides
ObjectBase.constructor
Constructor
new SplitOptions(
baseSplitOptions,properties?):SplitOptions
Creates a new SplitOptions based on properties of an existing SplitOptions.
Parameters
baseSplitOptions
SplitOptions
The SplitOptions object used as the base for the new SplitOptions.
properties?
The settings overriding properties of the base SplitOptions.
Returns
SplitOptions
Overrides
ObjectBase.constructor
Constructor
new SplitOptions(
om,properties?):SplitOptions
Creates a new SplitOptions object with specified properties.
Parameters
om
An object manager that controls the lifetime of the SplitOptions object.
properties?
The options for text splitting.
Returns
SplitOptions
Overrides
ObjectBase.constructor
Accessors
addSpacingAfterLastLine
Get Signature
get addSpacingAfterLastLine():
boolean
Gets or sets a value indicating whether a line spacing should be added after the last line of the current Layout after splitting.
Returns
boolean
Set Signature
set addSpacingAfterLastLine(
value):void
Gets or sets a value indicating whether a line spacing should be added after the last line of the current Layout after splitting.
Parameters
value
boolean
Returns
void
allowMovingAllToRest
Get Signature
get allowMovingAllToRest():
boolean
Gets or sets a value indicating whether, if no part of the content can fit in the current layout, to move all content to rest Layout.
Returns
boolean
Set Signature
set allowMovingAllToRest(
value):void
Gets or sets a value indicating whether, if no part of the content can fit in the current layout, to move all content to rest Layout.
Parameters
value
boolean
Returns
void
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
keepParagraphLinesTogether
Get Signature
get keepParagraphLinesTogether():
boolean
Gets or sets a value indicating whether paragraphs should be kept together (cannot be split between pages or columns).
Returns
boolean
Set Signature
set keepParagraphLinesTogether(
value):void
Gets or sets a value indicating whether paragraphs should be kept together (cannot be split between pages or columns).
Parameters
value
boolean
Returns
void
lineGapBeforeFirstLine
Get Signature
get lineGapBeforeFirstLine():
boolean
Gets or sets a value indicating whether the typographic line gap should be added before the first line of the rest Layout.
Returns
boolean
Set Signature
set lineGapBeforeFirstLine(
value):void
Gets or sets a value indicating whether the typographic line gap should be added before the first line of the rest Layout.
Parameters
value
boolean
Returns
void
minLinesInFirstParagraph
Get Signature
get minLinesInFirstParagraph():
number
Gets or sets the minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows.
Returns
number
Set Signature
set minLinesInFirstParagraph(
value):void
Gets or sets the minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows.
Parameters
value
number
Returns
void
minLinesInLastParagraph
Get Signature
get minLinesInLastParagraph():
number
Gets or sets the minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans.
Returns
number
Set Signature
set minLinesInLastParagraph(
value):void
Gets or sets the minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans.
Parameters
value
number
Returns
void
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
restColumnWidth
Get Signature
get restColumnWidth():
number|null
Gets or sets the width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units.
Returns
number | null
Set Signature
set restColumnWidth(
value):void
Gets or sets the width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units.
Parameters
value
number | null
Returns
void
restMarginBottom
Get Signature
get restMarginBottom():
number
Gets or sets the bottom margin of the layout box for the rest of the text after splitting, in graphic units.
Returns
number
Set Signature
set restMarginBottom(
value):void
Gets or sets the bottom margin of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number
Returns
void
restMarginLeft
Get Signature
get restMarginLeft():
number
Gets or sets the left margin of the layout box for the rest of the text after splitting, in graphic units.
Returns
number
Set Signature
set restMarginLeft(
value):void
Gets or sets the left margin of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number
Returns
void
restMarginRight
Get Signature
get restMarginRight():
number
Gets or sets the right margin of the layout box for the rest of the text after splitting, in graphic units.
Returns
number
Set Signature
set restMarginRight(
value):void
Gets or sets the right margin of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number
Returns
void
restMarginTop
Get Signature
get restMarginTop():
number
Gets or sets the top margin of the layout box for the rest of the text after splitting, in graphic units.
Returns
number
Set Signature
set restMarginTop(
value):void
Gets or sets the top margin of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number
Returns
void
restMaxHeight
Get Signature
get restMaxHeight():
number|null
Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units.
Returns
number | null
Set Signature
set restMaxHeight(
value):void
Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number | null
Returns
void
restMaxWidth
Get Signature
get restMaxWidth():
number|null
Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units.
Returns
number | null
Set Signature
set restMaxWidth(
value):void
Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units.
Parameters
value
number | null
Returns
void
restRowHeight
Get Signature
get restRowHeight():
number|null
Gets or sets the height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units.
Returns
number | null
Set Signature
set restRowHeight(
value):void
Gets or sets the height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units.
Parameters
value
number | null
Returns
void
Methods
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void