Class Movie
The Class Movie.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFNet.dll
Syntax
public class Movie : Annot, IDisposableConstructors
Movie(Annot)
Creates a Movie annotation and initialize it using given annotation object.
Declaration
public Movie(Annot ann)Parameters
| Type | Name | Description |
|---|---|---|
| Annot | ann | the annot |
Remarks
The constructor does not copy any data, but is instead the logical equivalent of a type cast.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Movie(Obj)
A movie annotation (PDF 1.2) contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie shall be played.
Declaration
public Movie(Obj d)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | d | the d |
Methods
Create(SDFDoc, Rect)
Creates a new Movie annotation, in the specified document.
Declaration
public static Movie Create(SDFDoc doc, Rect pos)Parameters
| Type | Name | Description |
|---|---|---|
| SDFDoc | doc | A document to which the Movie annotation is added. |
| Rect | pos | A rectangle specifying the Movie annotation's bounds, specified in user space coordinates. |
Returns
| Type | Description |
|---|---|
| Movie | A newly created blank Movie annotation. |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Dispose(bool)
Declaration
[HandleProcessCorruptedStateExceptions]
protected override void Dispose(bool A_0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | A_0 |
Overrides
GetTitle()
Gets the title of the Movie Annotation.
Declaration
public string GetTitle()Returns
| Type | Description |
|---|---|
| string | A string representing the title of the Movie Annotation |
Remarks
Movie actions may use this title to reference the movie annotation.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
IsToBePlayed()
Gets the option of whether the Movie is to be played.
Declaration
public bool IsToBePlayed()Returns
| Type | Description |
|---|---|
| bool | a boolean value indicating if the movie is to be played |
Remarks
IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
SetTitle(string)
Sets the title of the Movie Annotation. (Optional)
Declaration
public void SetTitle(string title)Parameters
| Type | Name | Description |
|---|---|---|
| string | title | A string representing the title of the Movie Annotation |
Remarks
Movie actions may use this title to reference the movie annotation.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
SetToBePlayed(bool)
Sets the option of whether the Movie is to be played. (Optional)
Declaration
public void SetToBePlayed(bool isplay)Parameters
| Type | Name | Description |
|---|---|---|
| bool | isplay | A boolean value telling if the movie is to be played. Default value: true. |
Remarks
IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |