PdfSoundLinkElement Class


PdfSoundLinkElement Class

Represents a link to an external sound file in a pdf document. Viewers that honor sound annotations play the referenced audio when the rectangle is clicked. Supported audio formats depend on the target viewer (Acrobat historically accepts WAV, AIFF).

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfPageElement
SelectPdf.UniversalPdfSoundLinkElement

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class PdfSoundLinkElement : PdfPageElement

Public Class PdfSoundLinkElement
	Inherits PdfPageElement

The PdfSoundLinkElement type exposes the following members.

Constructors

	Name	Description
	PdfSoundLinkElement(RectangleF, String)	Constructs an external sound link pdf element.
	PdfSoundLinkElement(Single, Single, Single, Single, String)	Convenience overload — creates the link from explicit x / y / width / height values.

Top

Properties

	Name	Description
	ActualText	Gets or sets the exact text represented by this element (the structure element's /ActualText entry), used when the drawn glyphs do not map to readable text. (Inherited from PdfPageElement)
	AlternateText	Gets or sets the alternate text describing this element for assistive technology (the structure element's /Alt entry). Required on figures for PDF/UA conformance. (Inherited from PdfPageElement)
	Artifact	Gets or sets a value indicating whether this element is an artifact — decorative or layout content that carries no meaning and is excluded from the logical structure (backgrounds, rules, running headers). Takes precedence over TagType. (Inherited from PdfPageElement)
	FileName	Gets or sets the external sound file path.
	LinkRectangle	Gets or sets the link rectangle in the pdf page.
	TagType	Gets or sets the structure type used to tag this element in a tagged (accessible) document. Ignored unless the document's tagged mode (PdfDocument.Tagged) is enabled. Null (default) leaves the element untagged unless Artifact is set. (Inherited from PdfPageElement)

Top

Example

Copy

PdfDocument document = new PdfDocument();
PdfPage page = document.AddPage();
PdfSoundLinkElement sound = new PdfSoundLinkElement(20, 20, 200, 20, "beep.wav");
page.Add(sound);
document.Save("out.pdf");
document.Close();

Dim document As New PdfDocument()
Dim page As PdfPage = document.AddPage()
Dim sound As New PdfSoundLinkElement(20, 20, 200, 20, "beep.wav")
page.Add(sound)
document.Save("out.pdf")
document.Close()

Reference

SelectPdf.Universal Namespace