Absatz: Bereichsbezogen, Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Erstellt ein Absatzobjekt, das einen Textblock in einer PDF-Datei darstellt.

    Diese API ist Teil des Plugins ServiceNow PDF Generierung Utilities (com.snc.apppdfgenerator) und wird im Namespace sn_pdfgeneratorutils bereitgestellt. Das Plugin ist standardmäßig aktiviert.

    Diese API ist eine Komponente, die mit der Dokument-API zum Generieren einer PDF-Datei verwendet wird.

    Absatz – Absatz (Zeichenfolgentext)

    Instanziiert ein neues Paragraph -Objekt, das eine Zeichenfolge enthält.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    text Zeichenfolge Absatzblock.

    Das folgende Beispiel zeigt, wie ein Paragraph- Objekt erstellt wird. 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.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie nach einem Absatz in einem Dokument eine neue Zeile hinzufügen. 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.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Absatz Absatz Absatzobjekt.
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einem Dokument einen Abschnitt mit Absätzen hinzufügen. 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. Diese Methode fügt nicht automatisch ein Leerzeichen vor dem Inhalt ein.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Content Zeichenfolge Informationen, die in einen Absatz aufgenommen werden sollen.
    Tabelle : 7. Ergebnisse
    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.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Stil Stil Auf dieses Element anzuwendender Stil.
    Tabelle : 9. Ergebnisse
    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(Linke Zahl, Zahl unten, Zahlbreite)

    Legt ein Absatzelement an einer festen Position auf der Seite fest.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Links Nummer Einzug von der linken Seite der PDF-Seite in Punkten.
    bottom Nummer Position vom unteren Rand der PDF-Seite in Punkten.
    width Nummer Breite des Absatzelements in Punkten. Dieser Wert bestimmt die Länge, bei der die Leitung umgebrochen wird.
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie eine feste Position auf einer Seite festgelegt 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);

// 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(Numbergrenzwert)

    Legt jeden Absatzrand fest.

    Um alle vier Ränder mit einem oder mehreren eindeutigen Werten festzulegen, verwenden Sie setMargins().

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Rand Nummer Wert des oberen, rechten, unteren und linken Randes in Punkten.
    Tabelle : 13. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie alle Ränder des Absatzes auf 48 Punkt 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 – setMarginBOTOM(Numbergrenzwert)

    Legt den unteren Rand eines Absatzes fest.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Rand Nummer Höhe des unteren Randes in Punkten.
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie den unteren Rand eines Absatzes auf einen Punkt festlegen.

    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.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    LeftMargin Nummer Breite des linken Rands in Punkten.
    Tabelle : 17. Ausgabe
    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 – setMarginRechts(Nummernrand)

    Legt den rechten Rand eines Absatzes fest.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Rand Nummer Breite des rechten Randes in Punkten.
    Tabelle : 19. Ergebnisse
    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, Nummer RandRechts, Nummer RandBunter, Nummer RandLeft)

    Legt eine Größe für jeden Absatzrand fest.

    Um jeden Rand auf den gleichen Wert festzulegen, verwenden Sie setMargin().

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    topMargin Nummer Höhe des oberen Randes in Punkten.
    rechten Rand Nummer Breite des rechten Randes in Punkten.
    unterer Rand Nummer Höhe des unteren Randes in Punkten.
    LeftMargin Nummer Breite des linken Rands in Punkten.
    Tabelle : 21. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einen Absatzrand festlegen.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.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    Rand Nummer Höhe des oberen Randes in Punkten.
    Tabelle : 23. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie den oberen Rand eines Absatzes auf einen Punkt festlegen.

    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.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    Ausrichtung Zeichenfolge Textausrichtungsposition.
    Gültige Werte:
    • text-center: Richtet den Text zentriert aus.
    • textorientiert: Ändert den Abstand zwischen den Zeichen, um den Text zwischen der linken und rechten Seite vollständig auszufüllen. Die letzte Zeile ist linksbündig.
    • text-berichtigt-all: Blockiert die Textausrichtung einschließlich der letzten Zeile.
    • text-left: Text links ausrichten.
    • text-right: Text rechts ausrichten.
    Tabelle : 25. Ausgabe
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie den Absatztext auf die linke Ausrichtung festlegen.

    var paragraph = new sn_pdfgeneratorutils.Paragraph("This paragraph text is centered.");
        
var alignment = "text-center";
       
paragraph.setTextAlignment(alignment);