getStructure

Versionshinweise	22.1, 21.2.06, 21.1.11

Code

GROOVY

String getStructure(PresentationDocument document, String identifier, int pageIndex)
String getStructure(PresentationDocument document, String identifier, int pageIndex, int columnIndex, int rowIndex)

Beschreibung

Ermittelt die Struktur des Wert einer Textkomponenten, Tabelle oder einer Tabellenzelle aus der übergebenen Präsentationsdatei.
Die Methode ist hilfreich für die Analyse einer bestehenden Präsentationsdatei, um gezielt Änderungen an einem Textinhalt vornehmen zu können (Erkennung von Absätzen und Textfragmenten).
Eine Erläuterung zur Verwendung von paragraphIndex und portionIndex findet sich unter PresentationUtils.setValue.

Parameter

document
Repräsentiert die Präsentationsdatei
identifier
Name der Textkomponente oder Tabelle
pageIndex
Index der Seite, auf der sich die Komponente befindet. (erste Seite startet mit 1)
columnIndex
Optionaler Parameter zur Adressierung einer Zelle
Index der Spalte der Zelle (erste Spalte startet mit 1)
Bei Verwendung von -1 als columnIndex und rowIndex wird die Struktur der Tabelle ausgegeben.
rowIndex
Optionaler Parameter zur Adressierung einer Zelle
Index der Zeile der Zelle (erste Zeile startet mit 1)
Bei Verwendung von -1 als columnIndex und rowIndex wird die Struktur der Tabelle ausgegeben.

Rückgabe

Struktur des Werte einer Textkomponente, einer Tabelle oder Tabellenzelle aus der übergebenen Präsentationsdatei.

Beispiele

GROOVY

IPresentationResult openResult = PresentationUtils.openFile("C:\\Work\\myFirstPresentation.ppsx");

if (!PresentationUtils.isSuccessful(openResult))
{
	/** handle error code */
    return;
}

PresentationDocument presentation = null;
try
{
  presentation = PresentationUtils.getPresentationDocument(openResult);

  String identifier = "Tab_Meassure";
  int pageIndex = 1;

  if (PresentationUtils.existsComponent(presentation, identifier, pageIndex))
  {
	   /** get structure of content of cell A1 of the table */
       String value = PresentationUtils.getStructure(presentation, identifier, pageIndex, 1, 1);

       /** Result for example
	    * <Cell (4/1)>
	    *     <TextFrame>
	    *           <Paragraph>
	    *                <Portion>Marketing flat rate for a term of </Portion>
	    *                <Portion>[€/MWh]</Portion>
	    *           </Paragraph>
	    *           <Paragraph>
	    *                <Portion>Please note</Portion>
	    *           </Paragraph>
	    *     </TextFrame>
	    * </Cell> 
       ...
  }
}
finally
{
  PresentationUtils.close(presentation);
}