Document Solutions for PDF
GrapeCity.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Annotations Namespace / SoundAnnotation Class
Properties Methods

In This Topic
    SoundAnnotation Class Members
    In This Topic

    The following tables list the members exposed by SoundAnnotation.

    Public Constructors
     NameDescription
    Public ConstructorSoundAnnotation ConstructorInitializes a new instance of the SoundAnnotation class.  
    Top
    Public Properties
     NameDescription
    Public PropertyAppearanceStateGets or sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance sub-dictionary. Note! If you change this property then GcPdf will NOT automatically generates appearance content streams in AppearanceStreams. See PDF specification for more details. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyAppearanceStreamsGets the AppearanceStreams object that allows defining this annotation's appearance streams. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyAssociatedFilesGets the list of embedded files associated with this AnnotationBase. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyColorGets or sets the annotation color, it used as color of popup window, lines color etc. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyContentsGets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. In either case, this text is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyCreationDateGets or sets the date and time when the annotation was created. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyDocGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyFlagsGets or sets the flags specifying various characteristics of the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyIconGets or sets a string specifying the name of an icon used to display the annotation.

    The PDF specification provides a predefined set of icons, those are provided by the SoundAnnotationIcon class.

     
    Public PropertyLayerGets or sets an object that specifies the layer to which this annotation belongs.

    This can be either an GrapeCity.Documents.Pdf.Layers.OptionalContentGroup or an GrapeCity.Documents.Pdf.Layers.OptionalContentMembership.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyLockedGets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyLockedContentsGets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyModifiedDateGets or sets the date and time when the annotation was modified. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyNameGets or sets the annotation name, a text string uniquely identifying it among all annotations on its page. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyObjIDGets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public PropertyOpacity (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyPageGets or sets the GrapeCity.Documents.Pdf.Page that contains this annotation.

    Note that an annotation may be referenced by several pages. In that case this property returns the first element in the Pages collection.

    When setting this property, the following applies:

    • If the new value is null, this annotation is removed from all pages.
    • Otherwise, this annotation is assigned exclusively to the specified page.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyPagesGets the list of pages that reference this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyPdfDictGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper)
    Public PropertyPdfObjectGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>)
    Public PropertyPdfRectGets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyPopupGets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation.Parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyRectGets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

    Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyReferenceAnnotationGets or sets the annotation referenced by this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyReferenceTypeGets or sets the relationship (reference type) between this annotation and the annotation specified by the ReferenceAnnotation property. The referenced annotation should be on the same page with the current annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyRichTextGets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertySoundGets or sets a GrapeCity.Documents.Pdf.SoundObject defining the sound to be played when the annotation is activated.  
    Public PropertySubjectGets or sets the text representing a short description of the subject being addressed by the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyUserDataGets or sets arbitrary data associated with the current annotation.

    Note that this data is runtime only and is not persisted in the PDF.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyUserNameGets or sets the text label to be displayed in the title bar of the annotation’s pop-up window when open and active. By convention, this entry identifies the user who added the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Top
    Public Methods
     NameDescription
    Public MethodCreateAppearanceContentStreamCreates an instance of GrapeCity.Documents.Pdf.Graphics.FormXObject that can be used to define the annotation's appearance stream.

    Note that when this method is called, the annotation must already have been added to the document, otherwise an exception will be thrown.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public MethodGetPdfStreamGets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamDataGets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamInfoGets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodRemoveAppearanceRemoves all appearance streams associated with the current annotation, and disables generation of appearance steams for this annotation when the document is saved.

    Note that if any property affecting the annotation's appearance (such as Rect) is then changed, the appearance streams will be regenerated. So this method would usually be called after initializing all annotation's properties.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public MethodResetAppearanceForces regeneration of the annotation's appearance streams next time the document is saved. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Top
    See Also

    Reference

    SoundAnnotation Class
    GrapeCity.Documents.Pdf.Annotations Namespace