Abrufen der Titel aller Folien in einer Präsentation

In diesem Thema wird gezeigt, wie Sie die Klassen im Open XML SDK für Office verwenden, um die Titel aller Folien in einer Präsentation programmgesteuert abzurufen.

---

Abrufen eines PresentationDocument-Objekts

Im Open XML SDK stellt die PresentationDocument -Klasse ein Präsentationsdokumentpaket dar. Um mit einem Präsentationsdokument zu arbeiten, erstellen Sie zuerst eine instance der PresentationDocument Klasse, und arbeiten Sie dann mit diesem instance. Um die Klasse instance aus dem Dokument zu erstellen, rufen Sie die Open -Methode auf, die einen Dateipfad verwendet, und einen booleschen Wert als zweiten Parameter, um anzugeben, ob ein Dokument bearbeitet werden kann. Um ein Dokument schreibgeschützt zu öffnen, geben Sie den Wert false für diesen Parameter an, wie in der folgenden using Anweisung gezeigt. In diesem Code ist der presentationFile Parameter eine Zeichenfolge, die den Pfad für die Datei darstellt, aus der Sie das Dokument öffnen möchten.

C#

// Open the presentation as read-only.
using (PresentationDocument presentationDocument = PresentationDocument.Open(presentationFile, false))

Visual Basic

' Open the presentation as read-only.
Using presentationDocument As PresentationDocument = PresentationDocument.Open(presentationFile, False)

Mit v3.0.0 und höher wurde die Close() -Methode entfernt, um sich auf die using-Anweisung zu verlassen. Dadurch wird sichergestellt, dass die Dispose() -Methode automatisch aufgerufen wird, wenn die schließende Klammer erreicht ist. Der Block, der auf die using -Anweisung folgt, richtet einen Bereich für das Objekt ein, das in der using -Anweisung erstellt oder benannt wird, in diesem Fall presentationDocument.

Grundlegende Präsentationsdokumentstruktur

Die grundlegende Dokumentstruktur eines PresentationML Dokuments besteht aus einer Reihe von Teilen, darunter der Standard Teil, der die Präsentationsdefinition enthält. Der folgende Text aus der SPEZIFIKATION ISO/IEC 29500 stellt die Gesamtform eines Pakets vor PresentationML .

Der Standard Teil eines PresentationML Pakets beginnt mit einem Präsentationsstammelement. Dieses Element enthält eine Präsentation, die wiederum auf eine Folienliste, eine Folie master Liste, eine Notizen- master Liste und ein Handzettel master Liste verweist. Die Folienliste bezieht sich auf alle Folien in der Präsentation; Die Folie master Liste bezieht sich auf die gesamten Folienmaster, die in der Präsentation verwendet werden; die Notizen master enthält Informationen zur Formatierung von Notizenseiten; und die Handzettel master beschreibt, wie ein Handzettel aussieht.

Ein Handzettel ist ein gedruckter Foliensatz, der an das Publikum verteilt werden kann.

Neben Text und Grafiken kann jede Folie Kommentare und Notizen enthalten, ein Layout aufweisen und Teil mindestens einer zielgruppenorientierten Präsentation sein. Ein Kommentar ist eine an die Person, die die Präsentationsfolien verwaltet, gerichtete Anmerkung. Eine Notiz ist eine Erinnerung oder eine kurze Textstelle, die für den Präsentator oder das Publikum bestimmt ist.

Weitere Features, die ein PresentationML Dokument umfassen kann: Animation, Audio, Video und Übergänge zwischen Folien.

Ein PresentationML Dokument wird nicht als ein großer Text in einem einzelnen Teil gespeichert. Die Elemente, mit deren Hilfe bestimmte Funktionsgruppierungen erfolgen, sind stattdessen in mehreren Teilen gespeichert. Beispielsweise werden alle Autoren in einem Dokument in einem Autorenteil gespeichert, während jede Folie über einen eigenen Teil verfügt.

ISO/IEC 29500: 2016

Das folgende XML-Codebeispiel stellt eine Präsentation dar, die zwei Folien mit den IDs 267 und 256 enthält.

    <p:presentation xmlns:p="…" … > 
       <p:sldMasterIdLst>
          <p:sldMasterId
             xmlns:rel="https://…/relationships" rel:id="rId1"/>
       </p:sldMasterIdLst>
       <p:notesMasterIdLst>
          <p:notesMasterId
             xmlns:rel="https://…/relationships" rel:id="rId4"/>
       </p:notesMasterIdLst>
       <p:handoutMasterIdLst>
          <p:handoutMasterId
             xmlns:rel="https://…/relationships" rel:id="rId5"/>
       </p:handoutMasterIdLst>
       <p:sldIdLst>
          <p:sldId id="267"
             xmlns:rel="https://…/relationships" rel:id="rId2"/>
          <p:sldId id="256"
             xmlns:rel="https://…/relationships" rel:id="rId3"/>
       </p:sldIdLst>
           <p:sldSz cx="9144000" cy="6858000"/>
       <p:notesSz cx="6858000" cy="9144000"/>
    </p:presentation>

Mit dem Open XML SDK können Sie Dokumentstrukturen und -inhalte mithilfe stark typisierter Klassen erstellen, die PresentationML-Elementen entsprechen. Sie finden diese Klassen im DocumentFormat.OpenXml.Presentation -Namespace. In der folgenden Tabelle sind die Klassennamen der Klassen aufgeführt, die den sldElementen , sldLayout, sldMasterund notesMaster entsprechen.

PresentationML-Element	Open XML SDK-Klasse	Beschreibung
<sld/>	Slide	Präsentationsfolie. Das SlidePart-Stammelement.
<sldLayout/>	SlideLayout	Das Folienlayout. Das SlideLayoutPart-Stammelement.
<sldMaster/>	SlideMaster	Der Folienmaster. Das SlideMasterPart-Stammelement.
<notesMaster/>	NotesMaster	Notizenmaster (oder Handzettelmaster). Das NotesMasterPart-Stammelement.

Beispielcode

Der folgende Beispielcode ruft alle Titel der Folien in einer Präsentationsdatei ab. Sie können beispielsweise die folgende foreach Anweisung in Ihrem Programm verwenden, um alle Titel in der Präsentationsdatei zurückzugeben, die sich am ersten Argument befinden.

C#

foreach(string title in GetSlideTitles(args[0]))
{
    Console.WriteLine(title);
}

Visual Basic

For Each title As String In GetSlideTitles(args(0))
    Console.WriteLine(title)
Next

Das Ergebnis wäre eine Liste der Zeichenfolgen, die die Titel in der Präsentation darstellen, wobei jeder Titel in einer separaten Zeile aufgeführt ist.

Es folgt der vollständige Beispielcode in C# und Visual Basic.

C#

// Get a list of the titles of all the slides in the presentation.
static IList<string> GetSlideTitles(string presentationFile)
{
    // Open the presentation as read-only.
    using (PresentationDocument presentationDocument = PresentationDocument.Open(presentationFile, false))
    {
        IList<string>? titles = GetSlideTitlesFromPresentation(presentationDocument);

        return (IList<string>)(titles ?? Enumerable.Empty<string>());
    }
}

// Get a list of the titles of all the slides in the presentation.
static IList<string>? GetSlideTitlesFromPresentation(PresentationDocument presentationDocument)
{
    // Get a PresentationPart object from the PresentationDocument object.
    PresentationPart? presentationPart = presentationDocument.PresentationPart;

    if (presentationPart is not null && presentationPart.Presentation is not null)
    {
        // Get a Presentation object from the PresentationPart object.
        Presentation presentation = presentationPart.Presentation;

        if (presentation.SlideIdList is not null)
        {
            List<string> titlesList = new List<string>();

            // Get the title of each slide in the slide order.
            foreach (var slideId in presentation.SlideIdList.Elements<SlideId>())
            {
                if (slideId.RelationshipId is null)
                {
                    continue;
                }

                SlidePart slidePart = (SlidePart)presentationPart.GetPartById(slideId.RelationshipId!);

                // Get the slide title.
                string title = GetSlideTitle(slidePart);

                // An empty title can also be added.
                titlesList.Add(title);
            }

            return titlesList;
        }

    }

    return null;
}

// Get the title string of the slide.
static string GetSlideTitle(SlidePart slidePart)
{
    if (slidePart is null)
    {
        throw new ArgumentNullException("presentationDocument");
    }

    // Declare a paragraph separator.
    string? paragraphSeparator = null;

    if (slidePart.Slide is not null)
    {
        // Find all the title shapes.
        var shapes = from shape in slidePart.Slide.Descendants<Shape>()
                     where IsTitleShape(shape)
                     select shape;

        StringBuilder paragraphText = new StringBuilder();

        foreach (var shape in shapes)
        {
            var paragraphs = shape.TextBody?.Descendants<D.Paragraph>();
            if (paragraphs is null)
            {
                continue;
            }

            // Get the text in each paragraph in this shape.
            foreach (var paragraph in paragraphs)
            {
                // Add a line break.
                paragraphText.Append(paragraphSeparator);

                foreach (var text in paragraph.Descendants<D.Text>())
                {
                    paragraphText.Append(text.Text);
                }

                paragraphSeparator = "\n";
            }
        }

        return paragraphText.ToString();
    }

    return string.Empty;
}

// Determines whether the shape is a title shape.
static bool IsTitleShape(Shape shape)
{
    PlaceholderShape? placeholderShape = shape.NonVisualShapeProperties?.ApplicationNonVisualDrawingProperties?.GetFirstChild<PlaceholderShape>();

    if (placeholderShape is not null && placeholderShape.Type is not null && placeholderShape.Type.HasValue)
    {
        return placeholderShape.Type == PlaceholderValues.Title || placeholderShape.Type == PlaceholderValues.CenteredTitle;
    }

    return false;
}

Visual Basic

' Get a list of the titles of all the slides in the presentation.
Function GetSlideTitles(presentationFile As String) As IList(Of String)
    ' Open the presentation as read-only.
    Using presentationDocument As PresentationDocument = PresentationDocument.Open(presentationFile, False)
        Dim titles As IList(Of String) = GetSlideTitlesFromPresentation(presentationDocument)

        Return If(titles, Enumerable.Empty(Of String)().ToList())
    End Using
End Function

' Get a list of the titles of all the slides in the presentation.
Function GetSlideTitlesFromPresentation(presentationDocument As PresentationDocument) As IList(Of String)
    ' Get a PresentationPart object from the PresentationDocument object.
    Dim presentationPart As PresentationPart = presentationDocument.PresentationPart

    If presentationPart IsNot Nothing AndAlso presentationPart.Presentation IsNot Nothing Then
        ' Get a Presentation object from the PresentationPart object.
        Dim presentation As Presentation = presentationPart.Presentation

        If presentation.SlideIdList IsNot Nothing Then
            Dim titlesList As New List(Of String)()

            ' Get the title of each slide in the slide order.
            For Each slideId As SlideId In presentation.SlideIdList.Elements(Of SlideId)()
                If slideId.RelationshipId Is Nothing Then
                    Continue For
                End If

                Dim slidePart As SlidePart = CType(presentationPart.GetPartById(slideId.RelationshipId), SlidePart)

                ' Get the slide title.
                Dim title As String = GetSlideTitle(slidePart)

                ' An empty title can also be added.
                titlesList.Add(title)
            Next

            Return titlesList
        End If
    End If

    Return Nothing
End Function

' Get the title string of the slide.
Function GetSlideTitle(slidePart As SlidePart) As String
    If slidePart Is Nothing Then
        Throw New ArgumentNullException(NameOf(slidePart))
    End If

    ' Declare a paragraph separator.
    Dim paragraphSeparator As String = Nothing

    If slidePart.Slide IsNot Nothing Then
        ' Find all the title shapes.
        Dim shapes = From shape In slidePart.Slide.Descendants(Of Shape)()
                     Where IsTitleShape(shape)
                     Select shape

        Dim paragraphText As New StringBuilder()

        For Each shape In shapes
            Dim paragraphs = shape.TextBody?.Descendants(Of D.Paragraph)()
            If paragraphs Is Nothing Then
                Continue For
            End If

            ' Get the text in each paragraph in this shape.
            For Each paragraph In paragraphs
                ' Add a line break.
                paragraphText.Append(paragraphSeparator)

                For Each text In paragraph.Descendants(Of D.Text)()
                    paragraphText.Append(text.Text)
                Next

                paragraphSeparator = vbLf
            Next
        Next

        Return paragraphText.ToString()
    End If

    Return String.Empty
End Function

' Determines whether the shape is a title shape.
Function IsTitleShape(shape As Shape) As Boolean
    Dim placeholderShape As PlaceholderShape = shape.NonVisualShapeProperties?.ApplicationNonVisualDrawingProperties?.GetFirstChild(Of PlaceholderShape)()

    If placeholderShape IsNot Nothing AndAlso placeholderShape.Type IsNot Nothing AndAlso placeholderShape.Type.HasValue Then
        Return placeholderShape.Type = PlaceholderValues.Title OrElse placeholderShape.Type = PlaceholderValues.CenteredTitle
    End If

    Return False
End Function

---

Siehe auch

Referenz zur Open XML SDK-Klassenbibliothek