|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
aspose.pdf.Attachment
public class Attachment
Represents an attachment Paragraph
in a Pdf document.
Attachment can be file attachment, stream attachment or note annotation.
Typical usages are the following:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class aspose.pdf.Paragraph |
---|
Paragraph.VerticalPositionInfo |
Field Summary |
---|
Fields inherited from class aspose.pdf.Paragraph |
---|
_realPageNumber, INNER_INDENT, isNeedAddToPage, isPositionProcessed, VerticalPosInfo |
Constructor Summary | |
---|---|
Attachment()
Constructor - initializes a new instance of the Attachment class. |
Method Summary | |
---|---|
java.lang.Object |
completeClone()
Clones a new Attachment . |
java.lang.String |
getAttachedFileName()
Gets a string that indicates the attach file name. |
java.lang.String |
getAttachedFileType()
Gets a string that indicates the MIME type of the attached file. |
BinaryFileStream |
getAttachedStream()
Gets a stream attached to the file. |
AttachmentType |
getAttachmentType()
Gets an AttachmentType object that indicates the attachment type. |
FileIconType |
getFileIconType()
Gets a FileIconType object that indicates the file attachment
icon type. |
Color |
getIconColor()
Gets a Color object that indicates the color of the icon. |
boolean |
getIsNoteOpen()
Gets a boolean value that indicates whether the note is open or not when the Pdf document is opened. |
java.lang.String |
getNoteContent()
Gets a string that indicates the content of the attached note. |
java.lang.String |
getNoteHeading()
Gets a string that indicates the heading (title) of the attached note. |
NoteIconType |
getNoteIconType()
Gets a NoteIconType object that indicates the note icon type. |
RectangleArea |
getNoteWindowPosition()
Gets a RectangleArea object that indicates the position of the note's
popup window. |
NoteWindowPositioningType |
getNoteWindowPositioningType()
Gets a NoteWindowPositioningType object that indicates the note window's
positioning type. |
void |
setAttachedFileName(java.lang.String value)
Sets a string that indicates the attach file name. |
void |
setAttachedFileType(java.lang.String value)
Sets a string that indicates the MIME type of the attached file. |
void |
setAttachedStream(BinaryFileStream value)
Sets a stream attaches to the file. |
void |
setAttachmentType(AttachmentType value)
Sets a AttachmentType that indicates the attachment type. |
void |
setFileIconType(FileIconType value)
Sets a FileIconType object that indicates the file attachment
icon type. |
void |
setIconColor(Color value)
Sets a Color object that indicates the color of the icon. |
void |
setIsNoteOpen(boolean value)
Sets a boolean value that indicates whether the note is open or not when the Pdf document is opened. |
void |
setNoteContent(java.lang.String value)
Sets a string that indicates the content of the attached note. |
void |
setNoteHeading(java.lang.String value)
Sets a string that indicates the heading (title) of the attached note. |
void |
setNoteIconType(NoteIconType value)
Sets a NoteIconType that indicates the note icon type. |
void |
setNoteWindowPosition(RectangleArea value)
Sets a RectangleArea object that indicates the position of the note's
popup window. |
void |
setNoteWindowPositioningType(NoteWindowPositioningType value)
Sets a NoteWindowPositioningType object that indicates the note window's
positioning type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Attachment()
Attachment
class.
Method Detail |
---|
public AttachmentType getAttachmentType()
AttachmentType
object that indicates the attachment type.
AttachmentType
object.public void setAttachmentType(AttachmentType value)
AttachmentType
that indicates the attachment type.
value
- An AttachmentType
object.public java.lang.String getAttachedFileName()
public void setAttachedFileName(java.lang.String value)
value
- A String value.public BinaryFileStream getAttachedStream()
BinaryFileStream
object.public void setAttachedStream(BinaryFileStream value)
value
- A BinaryFileStream
object.public java.lang.String getAttachedFileType()
public void setAttachedFileType(java.lang.String value)
value
- A String value.public FileIconType getFileIconType()
FileIconType
object that indicates the file attachment
icon type.
FileIconType
object.public void setFileIconType(FileIconType value)
FileIconType
object that indicates the file attachment
icon type.
value
- A FileIconType
object.public NoteWindowPositioningType getNoteWindowPositioningType()
NoteWindowPositioningType
object that indicates the note window's
positioning type. Default is Auto.
NoteWindowPositioningType
object.public void setNoteWindowPositioningType(NoteWindowPositioningType value)
NoteWindowPositioningType
object that indicates the note window's
positioning type. Default is Auto.
value
- A NoteWindowPositioningType
object.public RectangleArea getNoteWindowPosition()
RectangleArea
object that indicates the position of the note's
popup window.
RectangleArea
object.public void setNoteWindowPosition(RectangleArea value)
RectangleArea
object that indicates the position of the note's
popup window.
value
- A RectangleArea
object.public java.lang.String getNoteContent()
public void setNoteContent(java.lang.String value)
value
- A String value.public java.lang.String getNoteHeading()
public void setNoteHeading(java.lang.String value)
value
- A String value.public NoteIconType getNoteIconType()
NoteIconType
object that indicates the note icon type.
NoteIconType
object.public void setNoteIconType(NoteIconType value)
NoteIconType
that indicates the note icon type.
value
- A NoteIconType
object.public boolean getIsNoteOpen()
public void setIsNoteOpen(boolean value)
value
- A boolean value.public Color getIconColor()
Color
object that indicates the color of the icon.
Color
object.public void setIconColor(Color value)
Color
object that indicates the color of the icon.
value
- A Color
object.public java.lang.Object completeClone()
Clones a new Attachment
.
completeClone
in class Paragraph
Attachment
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |