Obter todos os títulos de todos os slides de uma apresentação

Este tópico mostra como utilizar as classes no SDK Open XML para o Office para obter os títulos de todos os diapositivos numa apresentação programaticamente.

---

Obter um Objeto PresentationDocument

No SDK Open XML, a PresentationDocument classe representa um pacote de documento de apresentação. Para trabalhar com um documento de apresentação, crie primeiro uma instância da PresentationDocument classe e, em seguida, trabalhe com essa instância. Para criar a instância de classe a partir do documento, chame o Open método que utiliza um caminho de ficheiro e um valor Booleano como segundo parâmetro para especificar se um documento é editável. Para abrir um documento só de leitura, especifique o valor false para este parâmetro, conforme mostrado na instrução seguinte using . Neste código, o presentationFile parâmetro é uma cadeia que representa o caminho para o ficheiro a partir do qual pretende abrir o documento.

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)

Com a v3.0.0+ o Close() método foi removido a favor de depender da instrução using. Isto garante que o Dispose() método é chamado automaticamente quando a chaveta de fecho é atingida. O bloco que segue a using instrução estabelece um âmbito para o objeto que é criado ou nomeado na using instrução , neste caso presentationDocument.

Estrutura básica do documento de apresentação

A estrutura de documentos básica de um PresentationML documento consiste em várias partes, entre as quais a main parte que contém a definição da apresentação. O texto seguinte da especificação ISO/IEC 29500 apresenta a forma geral de um PresentationML pacote.

O main parte de um PresentationML pacote começa com um elemento raiz de apresentação. Esse elemento contém uma apresentação que, por sua vez, se refere a uma lista de diapositivos, a uma lista de master de diapositivos, a uma lista de notas master e a um folheto master lista. A lista de diapositivos refere-se a todos os diapositivos na apresentação; A lista de master de diapositivos refere-se a todos os modelos globais de diapositivos utilizados na apresentação; as notas master contêm informações sobre a formatação das páginas de notas; e o master de folheto descreve o aspeto de um folheto.

Um folheto é um conjunto impresso de diapositivos que podem ser fornecidos a uma audiência.

Além de texto e gráficos, cada diapositivo pode conter comentários e notas, pode ter um esquema e pode fazer parte de uma ou mais apresentações personalizadas. Um comentário é uma anotação destinada à pessoa que mantém o conjunto de diapositivos da apresentação. Uma nota é um lembrete ou texto destinado ao apresentador ou à audiência.

Outras funcionalidades que um PresentationML documento pode incluir: animação, áudio, vídeo e transições entre diapositivos.

Um PresentationML documento não é armazenado como um corpo grande numa única parte. Em vez disso, os elementos que implementam determinados agrupamentos de funcionalidades são armazenados em partes separadas. Por exemplo, todos os autores num documento são armazenados numa parte dos autores, enquanto cada diapositivo tem a sua própria parte.

ISO/IEC 29500: 2016

O seguinte exemplo de código XML representa uma apresentação que contém dois diapositivos indicados pelos IDs 267 e 256.

    <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>

Com o SDK Open XML, pode criar a estrutura e o conteúdo do documento com classes com tipos fortes que correspondem a elementos PresentationML. Pode encontrar estas classes no espaço de nomes. A tabela seguinte lista os nomes das classes que correspondem aos sldelementos , sldLayout, sldMastere notesMaster .

Elemento PresentationML	Abrir Classe SDK XML	Descrição
<sld/>	Slide	Diapositivo de Apresentação. É o elemento raiz de SlidePart.
<sldLayout/>	SlideLayout	Esquema de Diapositivo. É o elemento raiz de SlideLayoutPart.
<sldMaster/>	SlideMaster	Modelo Global de Diapositivos. É o elemento raiz de SlideMasterPart.
<notesMaster/>	NotesMaster	Modelo Global de Notas (ou handoutMaster). É o elemento raiz de NotesMasterPart.

Código de exemplo

O código de exemplo seguinte obtém todos os títulos dos diapositivos num ficheiro de apresentação. Por exemplo, pode utilizar a seguinte foreach instrução no programa para devolver todos os títulos no ficheiro de apresentação localizado no primeiro argumento.

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

O resultado seria uma lista das cadeias que representam os títulos na apresentação, cada uma numa linha separada.

A seguir está o código de exemplo completo em C# e em 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

---

Confira também

Open XML SDK class library reference (Referência da biblioteca de classes SDK Open XML)