Xamarin.iOS

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfSoundAction

    Show / Hide Table of Contents

    Class PdfSoundAction

    Represents the sound action,sound action plays a specified music file in the PDF document

    Inheritance
    System.Object
    PdfAction
    PdfSoundAction
    Inherited Members
    PdfAction.Next
    Namespace: Syncfusion.Pdf.Interactive
    Assembly: Syncfusion.Pdf.Portable.dll
    Syntax
    public class PdfSoundAction : PdfAction, IPdfWrapper
    Remarks

    This PdfSoundAction class is used to plays a music file in PDF document. Please refer the UG docuemntation link for more details.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF 
    document.Save("Output.pdf")
    document.Close(True)

    Constructors

    PdfSoundAction(Stream)

    Declaration
    public PdfSoundAction(Stream data)
    Parameters
    Type Name Description
    System.IO.Stream data

    Properties

    FileName

    Declaration
    public string FileName { get; set; }
    Property Value
    Type Description
    System.String

    The name of the sound file.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    //Get the fileName form soundAction
    string fileName=soundAction.FileName;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    'Get the fileName form soundAction
     Dim fileName as string =soundAction.FileName;
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Mix

    Gets or sets a value indicating whether to mix this sound with any other sound already playing. If this flag is false, any previously playing sound is stopped before starting this sound; this can be used to stop a repeating sound. Default value: false.

    Declaration
    public bool Mix { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if mix; otherwise, false.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    soundAction.Mix = true;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    soundAction.Mix = True
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Repeat

    Gets or sets a value indicating whether to repeat the sound indefinitely. If this entry is present, the Synchronous property is ignored. Default value: false.

    Declaration
    public bool Repeat { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if repeat; otherwise, false.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    soundAction.Repeat = true;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
     soundAction.Repeat = True
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Sound

    Gets or sets the sound.

    Declaration
    public PdfSound Sound { get; set; }
    Property Value
    Type Description
    PdfSound

    PdfSound represents the PdfSound.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Synchronous

    Gets or sets a value whether to play the sound synchronously or asynchronously. If this flag is true, the viewer application retains control, allowing no further user interaction other than canceling the sound, until the sound has been completely played. Default value: false.

    Declaration
    public bool Synchronous { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if synchronous; otherwise, false.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    soundAction.Synchronous = true;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    soundAction.Synchronous = True
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Volume

    Gets or sets the volume at which to play the sound, in the range -1.0 to 1.0.

    Declaration
    public float Volume { get; set; }
    Property Value
    Type Description
    System.Single

    The volume of the sound.

    Examples
    //Create a new document
    PdfDocument document = new PdfDocument();
    //Add a page.
    PdfPage page = document.Pages.Add();
    //Create a sound action
    PdfSoundAction soundAction = new PdfSoundAction("../../Data/Startup.wav");
    soundAction.Sound.Bits = 16;
    soundAction.Sound.Channels = PdfSoundChannels.Stereo;
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed;
    soundAction.Volume = 0.9f;
    //Set the sound action
    document.Actions.AfterOpen = soundAction;
    //Save and close the PDF document
    document.Save("Output.pdf");
    document.Close(true);
    'Create a new document
    Dim document As New PdfDocument()
    'Add a page.
    Dim page As PdfPage = document.Pages.Add()
    'Create a sound action
    Dim soundAction As New PdfSoundAction("../../Data/Startup.wav")
    soundAction.Sound.Bits = 16
    soundAction.Sound.Channels = PdfSoundChannels.Stereo
    soundAction.Sound.Encoding = PdfSoundEncoding.Signed
    soundAction.Volume = 0.9F
    'Set the sound action
    document.Actions.AfterOpen = soundAction
    'Save and close the PDF document
    document.Save("Output.pdf")
    document.Close(True)
    See Also
    PdfPage
    PdfActionCollection

    Methods

    Initialize()

    Initializes instance.

    Declaration
    protected override void Initialize()
    Overrides
    PdfAction.Initialize()

    See Also

    PdfPage
    PdfActionCollection
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved