Absatz: Umfang, Global
Erstellt ein Absatzobjekt, das einen Textblock in einer PDF-Datei darstellt.
Diese API ist Teil von ServiceNow Plugin „PDF-Generierungsdienstprogramme“ (com.snc.apppdfgenerator) und wird in bereitgestellt sn_pdfgeneratorutils Namespace. Das Plugin ist standardmäßig aktiviert.
Diese API ist eine Komponente, die mit verwendet wird Dokument-API Dient zum Generieren einer PDF-Datei.
Absatz: Absatz (Zeichenfolgentext)
Instanziiert eine neue Absatz Objekt, das eine Zeichenfolge enthält.
| Name | Typ | Beschreibung |
|---|---|---|
| text | Zeichenfolge | Absatzblock des Texts. |
Das folgende Beispiel zeigt, wie ein erstellt wird Absatz Objekt. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var para = new Paragraph("hello");
Absatz – addNewLine()
Fügt eine leere Zeile nach einem Absatz in einem Dokument hinzu.
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie nach einem Absatz in einem Dokument eine neue Zeile hinzugefügt wird. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var myPara = new sn_pdfgeneratorutils.Paragraph("This is a paragraph.");
myPara.addNewLine();
document.addParagraph(myPara);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "addText.pdf");
Absatz – addParagraph (Absatz)
Fügt einen Absatz hinzu. Sie können diese Methode verwenden, um einen Block von Absätzen mit automatischen Zeilenumbrüchen zu erstellen.
| Name | Typ | Beschreibung |
|---|---|---|
| Absatz | Absatz | Absatzobjekt. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie einem Dokument ein Abschnitt von Absätzen hinzugefügt wird. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var sectionPara = new sn_pdfgeneratorutils.Paragraph("This is the first paragraph.");
var subPara1 = new sn_pdfgeneratorutils.Paragraph("Pellentesque nec neque interdum turpis ultricies tristique at ut lacus. Nam eget sollicitudin.");
var subPara2 = new sn_pdfgeneratorutils.Paragraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vel ultrices erat.");
var subPara3 = new sn_pdfgeneratorutils.Paragraph("Aenean fermentum lorem congue metus faucibus, vitae viverra quam eleifend. Donec sed risus quis eros suscipit efficitur.");
sectionPara.addParagraph(subPara1);
sectionPara.addParagraph(subPara2);
sectionPara.addParagraph(subPara3);
document.addParagraph(sectionPara);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");
Absatz – addString(Zeichenfolgeninhalt)
Fügt einem Absatz eine Textzeichenfolge hinzu. Bei dieser Methode wird nicht automatisch ein Leerzeichen vor dem Inhalt eingefügt.
| Name | Typ | Beschreibung |
|---|---|---|
| Content | Zeichenfolge | Informationen, die in einen Absatz aufgenommen werden sollen. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie einem Absatz ein neuer Satz hinzugefügt wird. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var myPara = new sn_pdfgeneratorutils.Paragraph("This is the first sentence.");
myPara.addString(" This is the second sentence in the same paragraph. Spaces are not inserted automatically.")
document.addParagraph(myPara);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");
Absatz – addStyle (Stilstil)
Wendet einen vordefinierten Stil auf den Absatztext an.
| Name | Typ | Beschreibung |
|---|---|---|
| Stil | Stil | Stil, der auf dieses Element angewendet werden soll. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie ein Stil auf einen Absatz angewendet wird. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
// Create a font color (result is purple)
var fontColor = new sn_pdfgeneratorutils.Color([0.5,0.0,0.5]);
// Create a style for your paragraph
var paraStyle = new sn_pdfgeneratorutils.Style();
paraStyle.setFontColor(fontColor);
paraStyle.setFontSize(10);
var myPara = new sn_pdfgeneratorutils.Paragraph("This paragraph has style.");
myPara.addStyle(paraStyle);
document.addParagraph(myPara);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "addStyle.pdf");
Absatz – setFixedPosition (Anzahl links, Zahl unten, Nummernbreite)
Legt ein Absatzelement an eine feste Position auf der Seite fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Links | Anzahl | Einzug von der linken Seite der PDF-Seite in Punkten. |
| bottom | Anzahl | Position von unten auf der PDF-Seite in Punkten. |
| width | Anzahl | Breite des Absatzelements in Punkten. Dieser Wert bestimmt die Länge, bei der die Linie umbricht. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie Sie eine feste Position auf einer Seite festlegen. Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
// Create a style
var paraStyle = new sn_pdfgeneratorutils.Style();
paraStyle.setFontSize(48);
paraStyle.setBold();
// my paragraph
var para = new sn_pdfgeneratorutils.Paragraph("Document Title");
para.setFixedPosition(204,400,240);
para.setTextAlignment("text-center");
para.addStyle(paraStyle);
document.addParagraph(para);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "fileName.pdf");
Absatz – setMargin(Nummernrand)
Legt jeden Absatzrand fest.
Um alle vier Ränder mit einem oder mehreren eindeutigen Werten festzulegen, verwenden Sie SetMargins() .
| Name | Typ | Beschreibung |
|---|---|---|
| Rand | Anzahl | Wert des oberen, rechten, unteren und linken Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie alle Ränder des Absatzes auf 48 Punkte festgelegt werden.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var margins = 48.0;
var myPara = new sn_pdfgeneratorutils.Paragraph("Paragraph text with all margins set to the same value.");
myPara.setMargin(margins);
document.addParagraph(myPara);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");
Absatz – setMarginBottom(Nummernrand)
Legt den unteren Rand eines Absatzes fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Rand | Anzahl | Höhe des unteren Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie der untere Rand eines Absatzes auf einen Punkt festgelegt wird.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var marginVal = 1.0;
var paraMarginBottom = new sn_pdfgeneratorutils.Paragraph("Paragraph text with bottom margin set.");
paraMarginBottom.setMarginBottom(marginVal);
document.addParagraph(paraMarginBottom);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");
Absatz – setMarginLeft(Nummernrand)
Legt den linken Rand eines Absatzes fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Linker Rand | Anzahl | Breite des linken Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie der linke Rand eines Absatzes auf einen Punkt festgelegt wird.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var marginVal = 1.0;
var paraMarginLeft = new sn_pdfgeneratorutils.Paragraph("Paragraph text with left margin set.");
paraMarginLeft.setMarginLeft(marginVal);
document.addParagraph(paraMarginLeft);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");
Absatz – setMarginRight(Nummernrand)
Legt den rechten Rand eines Absatzes fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Rand | Anzahl | Breite des rechten Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie der rechte Rand eines Absatzes auf einen Punkt festgelegt wird.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var marginVal = 1.0;
var paraMarginRight = new sn_pdfgeneratorutils.Paragraph("Paragraph text with right margin set.");
paraMarginRight.setMarginRight(marginVal);
document.addParagraph(paraMarginRight);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");
Absatz – setMargins(Number marginTop, Number marginRight, Number marginBottom, Number marginLeft)
Legt eine Größe für jeden Absatzrand fest.
Um jeden Rand auf denselben Wert festzulegen, verwenden Sie SetMargin() .
| Name | Typ | Beschreibung |
|---|---|---|
| Oberer Rand | Anzahl | Höhe des oberen Rands in Punkten. |
| Rechter Margin | Anzahl | Breite des rechten Rands in Punkten. |
| BottomMargin | Anzahl | Höhe des unteren Rands in Punkten. |
| Linker Rand | Anzahl | Breite des linken Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie Absatzränder festgelegt werden.Ein Beispiel für die Dokumentverwendung finden Sie unter Dokument API.
var para = new sn_pdfgeneratorutils.Paragraph("Paragraph text.");
var topMargin = 1.0;
var rightMargin = 1.0;
var bottomMargin = 1.0;
var leftMargin = 1.5;
para.setMargins(marginTop, marginRight, marginBottom, marginLeft);
Absatz – setMarginTop(Nummernrand)
Legt den oberen Rand eines Absatzes fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Rand | Anzahl | Höhe des oberen Rands in Punkten. |
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie der obere Rand eines Absatzes auf einen Punkt festgelegt wird.
var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
var marginVal = 1.0;
var paraMarginTop = new sn_pdfgeneratorutils.Paragraph("Paragraph text with top margin set.");
paraMarginTop.setMarginTop(marginVal);
document.addParagraph(paraMarginTop);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");
Absatz – setTextAlignment (Zeichenfolgenausrichtung)
Legt die Textausrichtung dieses Absatzes fest.
| Name | Typ | Beschreibung |
|---|---|---|
| Ausrichtung | Zeichenfolge | Textausrichtungsposition. Gültige Werte:
|
| Typ | Beschreibung |
|---|---|
| Keine |
Das folgende Beispiel zeigt, wie der Absatztext links ausgerichtet wird.
var paragraph = new sn_pdfgeneratorutils.Paragraph("This paragraph text is centered.");
var alignment = "text-center";
paragraph.setTextAlignment(alignment);