[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.Annotations.RichMediaAnnotation

Class RichMediaAnnotation

Namespace
GrapeCity.Documents.Pdf.Annotations
Assembly
GcDocs.Pdf.dll

Represents a rich media annotation. Rich media annotations provide a common framework for video, audio, animations and other multimedia presentations.

public class RichMediaAnnotation : AnnotationBase, IOwnedObject, IContentItem, IPdfDict
Inheritance
object
RichMediaAnnotation
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

RichMediaAnnotation()

Initializes a new instance of the RichMediaAnnotation class.

public RichMediaAnnotation()

Properties

ActivationCondition

Gets or sets the IPdfName object specifying the circumstances under which the annotation shall be activated. The RichMediaAnnotationActivation static class defines the valid values.

public IPdfName ActivationCondition { get; set; }

Property Value

IPdfName

DeactivationCondition

Gets or sets the IPdfName object specifying the circumstances under which the annotation shall be deactivated. The RichMediaAnnotationDeactivation static class defines the valid values.

public IPdfName DeactivationCondition { get; set; }

Property Value

IPdfName

PresentationStyle

Gets or sets the IPdfName object specifying the style of presentation of the rich media (embedded or windowed). The RichMediaAnnotationPresentationStyle static class defines the valid values.

public IPdfName PresentationStyle { get; set; }

Property Value

IPdfName

ShowNavigationPane

Gets or sets a value indicating the default behavior of a navigation pane user interface element. If true, the navigation pane should be visible when the content is initially activated. If false, the navigation pane should not be displayed. The default is false.

public bool ShowNavigationPane { get; set; }

Property Value

bool

ShowToolbar

Gets or sets the value indicating the default behavior of an interactive toolbar associated with this annotation. If true, the toolbar should be displayed when the annotation is activated and given focus. If false, the toolbar should not be displayed.

public bool ShowToolbar { get; set; }

Property Value

bool

Methods

GetContent(out RichMediaAnnotationContentType?)

Gets the FileSpecification object representing the content associated with this RichMediaAnnotation.

public FileSpecification GetContent(out RichMediaAnnotationContentType? contentType)

Parameters

contentType RichMediaAnnotationContentType?

OUT: The content type.

Returns

FileSpecification

The file specification representing the content, or null if the content cannot be extracted.

SetAudio(FileSpecification)

Sets the content of this RichMediaAnnotation to the audio represented by a FileSpecification object.

public void SetAudio(FileSpecification content)

Parameters

content FileSpecification

The FileSpecification object representing the audio content.

SetContent(FileSpecification, RichMediaAnnotationContentType)

Sets the content of this RichMediaAnnotation.

public void SetContent(FileSpecification content, RichMediaAnnotationContentType contentType)

Parameters

content FileSpecification

The FileSpecification object representing the content.

contentType RichMediaAnnotationContentType

The content type.

SetVideo(FileSpecification)

Sets the content of this RichMediaAnnotation to the video represented by a FileSpecification object.

public void SetVideo(FileSpecification content)

Parameters

content FileSpecification

The FileSpecification object representing the video content.