PdfSoundAnnotation Class

A sound annotation (PDF 1.2) is analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer’s microphone or imported from a file. When the annotation is activated, the sound is played. The annotation behaves like a text annotation in most ways, with a different icon (by default, a speaker) to indicate that it represents a sound.

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      Patagames.Pdf.Net.AnnotationsPdfMarkupAnnotation
        Patagames.Pdf.Net.AnnotationsPdfSoundAnnotation

Namespace: Patagames.Pdf.Net.Annotations
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704

Syntax

C++

JavaScript

Copy

public class PdfSoundAnnotation : PdfMarkupAnnotation

Public Class PdfSoundAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfSoundAnnotation : public PdfMarkupAnnotation

type PdfSoundAnnotation = 
    class
        inherit PdfMarkupAnnotation
    end

public class PdfSoundAnnotation extends PdfMarkupAnnotation

Patagames.Pdf.Net.Annotations.PdfSoundAnnotation = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfSoundAnnotation',
	Patagames.Pdf.Net.Annotations.PdfMarkupAnnotation);

The PdfSoundAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfSoundAnnotation(PdfPage)	Creates a new PdfSoundAnnotation.
	PdfSoundAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfScreenAnnotation class based on the specified dictionary.
	PdfSoundAnnotation(PdfPage, SoundIconNames, Single, Single, PdfSound)	Creates a new PdfSoundAnnotation with specified parameters.
	PdfSoundAnnotation(PdfPage, SoundIconNames, FS_COLOR, Single, Single, PdfSound)	Creates a new PdfSoundAnnotation with specified parameters.
	PdfSoundAnnotation(PdfPage, SoundIconNames, Single, Single, Byte, SoundEncodingFormats, Int32, Int32, Int32)	Creates a new PdfSoundAnnotation with specified parameters.
	PdfSoundAnnotation(PdfPage, SoundIconNames, FS_COLOR, Single, Single, Byte, SoundEncodingFormats, Int32, Int32, Int32)	Creates a new PdfSoundAnnotation with specified parameters.

Top

Properties

	Name	Description
	ExtendedIconName	The name of an icon to be used in displaying the annotation.
	Sound	Gets or sets a sound object defining the sound to be played when the annotation is activated.
	StandardIconName	The name of an icon to be used in displaying the annotation.

Top

Methods

	Name	Description
	RegenerateAppearances	Re-creates the appearance of the annotation based on its properties. (Overrides PdfMarkupAnnotationRegenerateAppearances)

Top

Reference

Patagames.Pdf.Net.Annotations Namespace