Obtener los títulos de todas las diapositivas de una presentación

En este tema se muestra cómo usar las clases del SDK de Open XML para Office para obtener los títulos de todas las diapositivas de una presentación mediante programación.

---

Obtención de un objeto PresentationDocument

En el SDK de Open XML, la clase PresentationDocument representa un paquete de documento de presentación. Para trabajar con un documento de presentación, debe crear primero una instancia de la clase PresentationDocument y, a continuación, trabajar con esa instancia. Para crear la instancia de clase a partir del documento, llame al método PresentationDocument.Open(String, Boolean) que usa una ruta de acceso de archivo y un valor booleano como segundo parámetro para especificar si un documento es editable. Para abrir un documento en modo de solo lectura, especifique el valor false para este parámetro, como se muestra en la siguiente instrucción using. En este código, el parámetro presentationFile es una cadena que representa la ruta de acceso del archivo a partir del cual desea abrir el documento.

C#

    // Open the presentation as read-only.
    using (PresentationDocument presentationDocument = PresentationDocument.Open(presentationFile, false))
    {
        // Insert other code here.
    }

Visual Basic

    ' Open the presentation as read-only.
    Using presentationDocument As PresentationDocument = PresentationDocument.Open(presentationFile, False)
        ' Insert other code here.
    End Using

La instrucción using proporciona una alternativa recomendada a la típica secuencia .Open, .Save, .Close. Asegura que se llamará automáticamente al método Dispose (un método interno que Open XML SDK usa para limpiar recursos) cuando se llegue a la llave de cierre. El bloque que sigue a la instrucción using establece un ámbito para el objeto que se crea o se nombra en la instrucción using, en este caso presentationDocument.

Estructura básica de un documento de presentación

La estructura básica de un documento PresentationML consta de varias partes, entre las que se encuentra la parte principal que contiene la definición de la presentación. El siguiente texto de la especificación ISO/IEC 29500 presenta la forma general de un paquete de PresentationML.

La parte principal de un paquete PresentationML comienza con un elemento raíz de presentación. Dicho elemento contiene una presentación que, a su vez, hace referencia a una lista de diapositivas, a otra de patrones de diapositivas, a otra de patrones de notas y a otra de patrones de documentos. La lista de diapositivas hace referencia a todas las diapositivas de la presentación, la de patrones de diapositivas a todos los patrones de diapositivas que se han usado en la presentación, el patrón de notas contiene información acerca del formato de las páginas de notas y el patrón de documentos describe la apariencia de los documentos.

Un documento es un conjunto impreso de diapositivas que se pueden proporcionar a un público.

Al igual que el texto y los gráficos, cada diapositiva puede incluir comentarios y notas, tener un diseño y formar parte de una o varias presentaciones personalizadas. Un comentario es una anotación dirigida a la persona que se encarga del mantenimiento de las diapositivas de la presentación. Una nota es un aviso o texto dirigido al moderador o al público.

Otras características que un documento PresentationML puede incluir son las siguientes: animación, audio, vídeo y transiciones entre diapositivas .

Los documentos PresentationML no se almacenan como un gran cuerpo en una sola parte. En su lugar, los elementos que implementan ciertas agrupaciones de funcionalidades se almacenan en partes independientes. Por ejemplo, todos los comentarios de un documento se almacenan en una parte de comentarios mientras que cada diapositiva cuenta con su propia parte.

© ISO/IEC29500: 2008.

El siguiente ejemplo de código XML representa una presentación que contiene dos diapositivas denotadas por los identificadores 267 y 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>

Con el SDK de Open XML, puede crear contenido y estructura de documentos mediante clases fuertemente tipadas que corresponden a elementos PresentationML. Puede encontrar estas clases en el espacio de nombres DocumentFormat.OpenXml.Presentation . En la tabla siguiente se enumeran los nombres de las clases que corresponden a los elementos sld, sldLayout, sldMaster y notesMaster.

Elemento de PresentationML	Open XML SDK (clase)	Descripción
Sld	Diapositiva	Diapositiva de presentación. Es el elemento raíz de SlidePart.
sldLayout	SlideLayout	Diseño de la diapositiva. Es el elemento raíz de SlideLayoutPart.
sldMaster	SlideMaster	Patrón de diapositivas. Es el elemento raíz de SlideMasterPart.
notesMaster	NotesMaster	Patrón de notas (o handoutMaster). Es el elemento raíz de NotesMasterPart.

Código de ejemplo

A continuación se proporciona el código de ejemplo completo, que se puede usar para obtener los títulos de las diapositivas de un archivo de presentación. Por ejemplo, puede usar la siguiente instrucción foreach en el programa para devolver todos los títulos del archivo de presentación, "Myppt9.pptx".

C#

    foreach (string s in GetSlideTitles(@"C:\Users\Public\Documents\Myppt9.pptx"))
       Console.WriteLine(s);

Visual Basic

    For Each s As String In GetSlideTitles("C:\Users\Public\Documents\Myppt9.pptx")
       Console.WriteLine(s)
    Next

El resultado será una lista de las cadenas que representan los títulos de la presentación, cada uno en una línea independiente.

A continuación se incluye el código de ejemplo completo en C# y Visual Basic.

C#

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Presentation;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using D = DocumentFormat.OpenXml.Drawing;

GetSlideTitles(args[0]);

// 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))
    {
        return GetSlideTitlesFromPresentation(presentationDocument);
    }
}

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

Imports System.Text
Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Presentation
Imports D = DocumentFormat.OpenXml.Drawing


Module MyModule

    Sub Main(args As String())
    End Sub

    ' Get a list of the titles of all the slides in the presentation.
    Public Function GetSlideTitles(ByVal presentationFile As String) As IList(Of String)

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

    End Function
    ' Get a list of the titles of all the slides in the presentation.
    Public Function GetSlideTitles(ByVal presentationDocument As PresentationDocument) As IList(Of String)
        If (presentationDocument Is Nothing) Then
            Throw New ArgumentNullException("presentationDocument")
        End If

        ' 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 List(Of String) = New List(Of String)

                ' Get the title of each slide in the slide order.
                For Each slideId As Object In presentation.SlideIdList.Elements(Of SlideId)()

                    Dim slidePart As SlidePart = CType(presentationPart.GetPartById(slideId.RelationshipId.ToString()), 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.
    Public Function GetSlideTitle(ByVal slidePart As SlidePart) As String
        If (slidePart Is Nothing) Then
            Throw New ArgumentNullException("presentationDocument")
        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 StringBuilder = New StringBuilder

            For Each shape As Object In shapes

                ' Get the text in each paragraph in this shape.
                For Each paragraph As Object In shape.TextBody.Descendants(Of D.Paragraph)()

                    ' Add a line break.
                    paragraphText.Append(paragraphSeparator)

                    For Each text As Object 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.
    Private Function IsTitleShape(ByVal shape As Shape) As Boolean
        Dim placeholderShape As Object = _
         shape.NonVisualShapeProperties.ApplicationNonVisualDrawingProperties.GetFirstChild(Of PlaceholderShape)()
        If (((placeholderShape) IsNot Nothing) _
           AndAlso (((placeholderShape.Type) IsNot Nothing) _
           AndAlso placeholderShape.Type.HasValue)) Then
            Select Case placeholderShape.Type.Value

                ' Any title shape
                Case PlaceholderValues.Title
                    Return True

                    ' A centered title.
                Case PlaceholderValues.CenteredTitle
                    Return True
                Case Else
                    Return False
            End Select
        End If
        Return False
    End Function
End Module

Vea también

Referencia de la biblioteca de clases del SDK de Open XML