{"id":2901,"date":"2016-03-19T05:06:07","date_gmt":"2016-03-19T05:06:07","guid":{"rendered":"http:\/\/www.ericwhite.com\/home2\/bm8qcmjy\/public_html\/blog\/?page_id=2901"},"modified":"2016-03-19T05:06:07","modified_gmt":"2016-03-19T05:06:07","slug":"deleting-slides-using-open-xml-sdk-2-0","status":"publish","type":"page","link":"https:\/\/www.ericwhite.com\/blog\/deleting-slides-using-open-xml-sdk-2-0\/","title":{"rendered":"Deleting Slides Using Open XML SDK 2.0"},"content":{"rendered":"

I usually like to use the Linq objects (XDpcument, XElement) when searching and modifying OpenXML documents. However, I know a lot of people prefer to use the specific objects available in version 2.0 of the SDK. For simple operations, this approach can work pretty well. I decided to try this approach while modifying an example I found in the forums that deletes hidden slides in a presentation. This example can be used as follows:<\/p>\n

using<\/span> <\/span>(<\/span>PresentationDocument<\/span> pdoc <\/span>=<\/span> <\/span>PresentationDocument<\/span>.<\/span>Open<\/span>(<\/span>\"Default.pptx\"<\/span>,<\/span> <\/span>true<\/span>))<\/span>
<\/span>{<\/span>
    <\/span>SlideId<\/span> _slideId <\/span>=<\/span> <\/span>GetHiddenSlide<\/span>(<\/span>pdoc<\/span>);<\/span>
    <\/span>if<\/span> <\/span>(<\/span>_slideId <\/span>!=<\/span> <\/span>null<\/span>)<\/span>
        <\/span>DeleteSlide<\/span>(<\/span>pdoc<\/span>,<\/span> _slideId<\/span>);<\/span>
    pdoc<\/span>.<\/span>Close<\/span>();<\/span>
<\/span>}<\/span><\/pre>\n
The GetHiddenSlide method will return the SlideId object for the slide to be deleted. DeleteSlide will delete the slide object specified. Of course, this will only delete the first hidden slide in the presentation. Deleting multiple hidden slides would require looping until GetHiddenSlide returns null, or changing GetHiddenSlide to return a list of SlideId objects.<\/p>\n
\/\/ Get the presentation object and pass it to the next CountSlides method.<\/span>
<\/span>public<\/span> <\/span>static<\/span> <\/span>SlideId<\/span> <\/span>GetHiddenSlide<\/span>(<\/span>PresentationDocument<\/span> presentationDocument<\/span>)<\/span>
<\/span>{<\/span>
    <\/span>\/\/ Open the presentation as read-only.<\/span>
        <\/span>SlideId<\/span> slideId <\/span>=<\/span> <\/span>null<\/span>;<\/span>
        <\/span>foreach<\/span> <\/span>(<\/span>SlidePart<\/span> slide <\/span>in<\/span> presentationDocument<\/span>.<\/span>PresentationPart<\/span>.<\/span>SlideParts<\/span>)<\/span>
        <\/span>{<\/span>
            <\/span>if<\/span> <\/span>(<\/span>slide<\/span>.<\/span>Slide<\/span>.<\/span>Show<\/span> <\/span>!=<\/span> <\/span>null<\/span> <\/span>&&<\/span> <\/span>!<\/span>slide<\/span>.<\/span>Slide<\/span>.<\/span>Show<\/span>)<\/span>
            <\/span>{<\/span>
                <\/span>string<\/span> slideRelId <\/span>=<\/span> presentationDocument<\/span>.<\/span>PresentationPart<\/span>.<\/span>GetIdOfPart<\/span>(<\/span>slide<\/span>);<\/span>
                <\/span>\/\/ Get the slide ID of the specified slide<\/span>
                slideId <\/span>=<\/span> presentationDocument<\/span>.<\/span>PresentationPart<\/span>.<\/span>Presentation<\/span>.<\/span>SlideIdList<\/span>.<\/span>ChildElements<\/span>.<\/span>Where<\/span>(<\/span>
                    s <\/span>=><\/span> <\/span>((<\/span>SlideId<\/span>)<\/span>s<\/span>).<\/span>RelationshipId<\/span> <\/span>==<\/span> slideRelId<\/span>).<\/span>FirstOrDefault<\/span>()<\/span> <\/span>as<\/span> <\/span>SlideId<\/span>;<\/span>
                <\/span>break<\/span>;<\/span>
            <\/span>}<\/span>
        <\/span>}<\/span>
        <\/span>\/\/ Pass the presentation to the next CountSlide method<\/span>
        <\/span>\/\/ and return the slide count.<\/span>
        <\/span>return<\/span> slideId<\/span>;<\/span>
<\/span>}<\/span><\/pre>\n
Here is the first example of using the SlideId object in a Linq query. Once the hidden slide is located, the Linq query is used to find the matching SlideId object in the presentation. That object is the one that will need to be removed from the presentation part. Conveniently, it also contains the relationship ID of the slide, which can be used to easily delete the slide part. All of that is done in the next method:<\/p>\n
\/\/ Delete the specified slide from the presentation.<\/span>
<\/span>public<\/span> <\/span>static<\/span> <\/span>void<\/span> <\/span>DeleteSlide<\/span>(<\/span>PresentationDocument<\/span> presentationDocument<\/span>,<\/span> <\/span>SlideId<\/span> slideId<\/span>)<\/span>
<\/span>{<\/span>
    <\/span>if<\/span> <\/span>(<\/span>presentationDocument <\/span>==<\/span> <\/span>null<\/span>)<\/span>
    <\/span>{<\/span>
        <\/span>throw<\/span> <\/span>new<\/span> <\/span>ArgumentNullException<\/span>(<\/span>\"presentationDocument\"<\/span>);<\/span>
    <\/span>}<\/span>
    <\/span>\/\/ Get the presentation from the presentation part.<\/span>
    <\/span>Presentation<\/span> presentation <\/span>=<\/span> presentationDocument<\/span>.<\/span>PresentationPart<\/span>.<\/span>Presentation<\/span>;<\/span>
    <\/span>\/\/ Remove the slide from the slide list.<\/span>
    presentation<\/span>.<\/span>SlideIdList<\/span>.<\/span>RemoveChild<\/span>(<\/span>slideId<\/span>);<\/span>

    <\/span>\/\/ Get the relationship ID of the slide.<\/span>
    <\/span>string<\/span> slideRelId <\/span>=<\/span> slideId<\/span>.<\/span>RelationshipId<\/span>;<\/span>
    <\/span>\/\/\/\/ Remove references to the slide from all custom shows.<\/span>
    <\/span>if<\/span> <\/span>(<\/span>presentation<\/span>.<\/span>CustomShowList<\/span> <\/span>!=<\/span> <\/span>null<\/span>)<\/span>
    <\/span>{<\/span>
        <\/span>\/\/ Iterate through the list of custom shows.<\/span>
        <\/span>foreach<\/span> <\/span>(<\/span>var<\/span> customShow <\/span>in<\/span> presentation<\/span>.<\/span>CustomShowList<\/span>.<\/span>Elements<\/span><<\/span>CustomShow<\/span>>())<\/span>
        <\/span>{<\/span>
            <\/span>if<\/span> <\/span>(<\/span>customShow<\/span>.<\/span>SlideList<\/span> <\/span>!=<\/span> <\/span>null<\/span>)<\/span>
            <\/span>{<\/span>
                <\/span>SlideListEntry<\/span> entry <\/span>=<\/span> customShow<\/span>.<\/span>SlideList<\/span>.<\/span>ChildElements<\/span>.<\/span>Where<\/span>(<\/span>s <\/span>=><\/span> <\/span>((<\/span>SlideListEntry<\/span>)<\/span>s<\/span>).<\/span>Id<\/span> <\/span>==<\/span> slideRelId<\/span>).<\/span>FirstOrDefault<\/span>()<\/span> <\/span>as<\/span> <\/span>SlideListEntry<\/span>;<\/span>
                <\/span>if<\/span> <\/span>(<\/span>entry <\/span>!=<\/span> <\/span>null<\/span>)<\/span>
                    customShow<\/span>.<\/span>SlideList<\/span>.<\/span>RemoveChild<\/span>(<\/span>entry<\/span>);<\/span>
            <\/span>}<\/span>
        <\/span>}<\/span>
    <\/span>}<\/span>
    <\/span>\/\/ Save the modified presentation.<\/span>
    presentation<\/span>.<\/span>Save<\/span>();<\/span>

    <\/span>\/\/ Remove the slide part.<\/span>
    presentationDocument<\/span>.<\/span>PresentationPart<\/span>.<\/span>DeletePart<\/span>(<\/span>slideRelId<\/span>);<\/span>
<\/span>}<\/span><\/pre>\n
There are three steps to deleting a slide. First, the SlideId entry is removed from the SlideIdList in the presentation part. Second, the slide may be referenced from any number of custom slide shows. The middle of the method iterates through the list of shows, but then uses a Linq query to find a matching entry in the show, if any, and delete it. Third, the slide part needs to be removed from the document. That can be done using the relationship ID for the slide.<\/p>\n
Notice that even though the Linq queries use generic objects, they can be easily cast to the appropriate object from the SDK 2.0. If it is not convenient to use the SlideId object for the delete method, then you could use a relationship ID instead and move the Linq query from GetHiddenSlide into the delete.<\/p>\n","protected":false},"excerpt":{"rendered":"
I usually like to use the Linq objects (XDpcument, XElement) when searching and modifying OpenXML documents. However, I know a lot of people prefer to use the specific objects available in version 2.0 of the SDK. For simple operations, this approach can work pretty well. I decided to try this approach while modifying an example […]<\/p>\n","protected":false},"author":10567,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"_s2mail":"","footnotes":""},"class_list":["post-2901","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/pages\/2901","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/users\/10567"}],"replies":[{"embeddable":true,"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/comments?post=2901"}],"version-history":[{"count":1,"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/pages\/2901\/revisions"}],"predecessor-version":[{"id":2902,"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/pages\/2901\/revisions\/2902"}],"wp:attachment":[{"href":"https:\/\/www.ericwhite.com\/blog\/wp-json\/wp\/v2\/media?parent=2901"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}