SetParaId
Specifies a unique ID for the current paragraph.
Syntax
expression.SetParaId(paraId);
expression - A variable that represents a ApiParagraph class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| paraId | Required | number | The numerical ID which will be specified for the current paragraph. Value MUST be greater than 0 and less than 0x80000000. |
Returns
boolean
Example
This example shows how to set the paragraph ID.
- Code
- Result
const doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText('This paragraph will have a custom ID.');
const customId = 920;
paragraph.SetParaId(customId);
paragraph = Api.CreateParagraph();
paragraph.AddText('Custom paragraph ID was set to: ' + customId);
doc.Push(paragraph);
const retrievedId = paragraph.GetParaId();
paragraph = Api.CreateParagraph();
paragraph.AddText('Retrieved paragraph ID: ' + retrievedId);
doc.Push(paragraph);