All docs
V21.2
21.2
21.1
The page you are viewing does not exist in version 21.1. This link will take you to the root page.
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfSoundAnnotationFacade Class

Contains members used to manage sound annotations without access to their inner structure.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.2.Core.dll

Declaration

public class PdfSoundAnnotationFacade :
    PdfMarkupAnnotationFacade

Remarks

Access Sound Annotations

Note

This annotation type is deprecated in PDF 2.0. You cannot add sound annotations to the PDF file.

The PdfPageFacade.Annotations property returns all page annotation properties. You can filter text annotation properties, cast them to the PdfSoundAnnotationFacade class, and use class properties to modify annotation parameters.

Flatten Sound Annotations

Utilize one of the following methods to flatten a sound annotation:

Method Description
PdfDocumentFacade.FlattenAnnotations() Flattens document annotations.
PdfPageFacade.FlattenAnnotations() Flattens annotations of a specific page.
PdfAnnotationFacade.Flatten() Flattens a specific annotation.

The code sample below flattens all sound annotations on the page.

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    // Load a document
    processor.LoadDocument("..\\..\\Document.pdf");

    // Access page properties
    PdfDocumentFacade facade = processor.DocumentFacade;
    PdfPageFacade page = facade.Pages[0];

    // Flatten all sound annotations
    page.FlattenAnnotations(PdfAnnotationType.Sound);
}

Remove Sound Annotations

Call the PdfAnnotationFacade.Remove() method to remove an annotation. The code sample below removes all sound annotations on the first page.

using DevExpress.Pdf;
using System.Linq;

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{

  // Load a document
  processor.LoadDocument("..\\..\\Document.pdf");

  // Access page properties
  PdfDocumentFacade facade = processor.DocumentFacade;
  PdfPageFacade page = facade.Pages[0];

  // Retrieve all sound annotations
  var soundAnnotations = page.Annotations.Where
    (annotation => annotation.Type == PdfAnnotationType.Sound).ToList();

  // Remove all sound annotations
  foreach (PdfSoundAnnotationFacade sound in soundAnnotations)
  {
      sound.Remove();
  }
}

s

Inheritance

See Also