setValue (PresentationUtils)

Code

boolean setValue(PresentationDocument document, String text, String identifier, int pageIndex, int paragraphIndex, int portionIndex)

Beschreibung

Setzen des Werts der Textkomponente in der übergebenen Präsentationsdatei.

Hinweis
Der Inhalt einer Textkomponente in einer Präsentationsdatei kann eine oder mehrere Absätze beinhalten. Oftmals entspricht eine Zeile einem eigenen Absatz .
Der Absatz selbst kann wiederum aus einem oder mehren Textfragmenten bestehen. Ein Textfragment repräsentiert eine formatierte Zeichenkette.
Werden also in einem Absatz Texte mit unterschiedlichen Formaten verwendet (z.B: fett), so wird jeder dieser formatierten Texte durch ein einzelnes Textfragment repräsentiert.

Verwendung

• Verwendung ohne Parameter paragraphIndex und portionIndex
  Ergebnis: Der komplette Inhalt der Textkomponente wird ersetzt
• Verwendung mit Parameter paragraphIndex und ohne portionIndex
  Ergebnis: Es wird nur der adressierte Absatz aktualisiert. 
• Verwendung mit Parameter paragraphIndex und portionIndex
  Ergebnis: Es wird nur das adressierte Textfragment in dem Absatz aktualisiert. 

Parameter

• document

  Repräsentiert die Präsentationsdatei.
• text
  Zu setzender Textwert
• identifier
  Name der Textkomponente
• pageIndex
  Index der Seite, auf der sich die Textkomponente befindet. (erste Seite startet mit 1)
• paragraphIndex

  Optionaler Parameter zur Adressierung auf Absatzebene
  Index des Absatzes (erster Absatz startet mit 1). Eine Textkomponente kann mehrere Absätze enthalten.

• portionIndex 
  Optionaler Parameter zur Adressierung auf Ebene eines Textfragments
  Index eines formatierten Textfragments in einer Zeile (erstes Textfragment startet mit 1). Eine Zeile kann mehrere formatierte Textfragmente enthalten.

Rückgabe
Liefert true, wenn das Setzen des Werts in der referenzierten Textkomponente erfolgreich war, ansonsten false.

Beispiele

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 = "myTitle";
  int pageIndex = 1;
  int paragraphIndex = 1;
  int portionindex = 3;

  if (PresentationUtils.existsComponent(presentation, identifier, pageIndex, paragraphIndex, portionindex))
  {
       boolean success = PresentationUtils.setValue(presentation, "modified textfragment", identifier, pageIndex, paragraphIndex, portionindex);
       ...
  }
  ...
}
finally
{
  PresentationUtils.close(presentation);
}