aspose.pdf
Class DocumentAttachment
java.lang.Object
aspose.pdf.Paragraph
aspose.pdf.DocumentAttachment
public class DocumentAttachment
- extends Paragraph
Represents a set of document level attachment in a Pdf document. Attachment can be file attachment,
stream attachment or note annotation.
Typical usages are the following:
<![CDATA[
[Java]
Pdf pdf1 = new Pdf();
Section sec1 = pdf1.getSections().add();
BinaryFileStream fstream;
fstream = new BinaryFileStream("c:/word.doc");
DocumentAttachment docStreamAttachment = new DocumentAttachment();
pdf1.getDocumentAttachments().add(docStreamAttachment);
docStreamAttachment.setDocumentAttachmentStream(fstream);
docStreamAttachment.setDocumentAttachmentCotentType("doc");
DocumentAttachment docFileAttachment = new DocumentAttachment();
pdf1.getDocumentAttachments().add(docFileAttachment);
docFileAttachment.setDocumentAttachmentFile("c:/image.jpg");
docFileAttachment.setDocumentAttachmentCotentType("jpeg");
Attachment pageFileAttachment = new Attachment();
sec1.getParagraphs().add(pageFileAttachment);
pageFileAttachment.setAttachmentType(AttachmentType.File);
pageFileAttachment.setAttachedFileName("c:/text.txt");
pageFileAttachment.setAttachedFileType("txt");
pageFileAttachment.setFileIconType(FileIconType.Graph);
pageFileAttachment.setIconColor(new aspose.pdf.Color("Brown"));
fstream = new BinaryFileStream("c:/readme.txt");
Attachment pageStreamAttachment = new Attachment();
sec1.getParagraphs().add(pageStreamAttachment);
pageStreamAttachment.setAttachedStream(fstream);
pageStreamAttachment.setAttachedFileType("txt");
pageStreamAttachment.setAttachmentType(AttachmentType.File);
pageStreamAttachment.setFileIconType(FileIconType.PaperClip);
Attachment pageNoteAttachment = new Attachment();
sec1.getParagraphs().add(pageNoteAttachment);
pageNoteAttachment.setAttachmentType(AttachmentType.Note);
pageNoteAttachment.setNoteContent("This is a note.");
pageNoteAttachment.setIsNoteOpen(true);
pdf1.Save("test.pdf");
[XML]
<?xml version="1.0" encoding="utf-8" ?>
<Pdf xmlns="Aspose.Pdf">
<DocumentAttachment DocumentAttachmentFileName="c:/word.doc"
DocumentAttachmentFileType="doc">
</DocumentAttachment>
<DocumentAttachment DocumentAttachmentFileName="c:/image.jpg"
DocumentAttachmentFileType="jpeg">
</DocumentAttachment>
<Section>
<Attachment AttachmentType="File" AttachedFileName="c:/text.txt" AttachedFileType="txt"
FileIconType="Graph" IconColor="Brown">
</Attachment>
<Attachment AttachmentType="File" AttachedFileName="c:/readme.txt" AttachedFileType="txt"
FileIconType="PaperClip">
</Attachment>
<Attachment AttachmentType="Note" IsNoteOpen="true"
NoteContent="This is a note.">
</Attachment>
</Section>
</Pdf>
]]>
| Methods inherited from class aspose.pdf.Paragraph |
copyTo, getHeight, getID, getIsNeedAddToPage, getIsPositionGot, getIsPositionProcessed, getLeft, getMargin, getMayNeedReprocess, getNeedReprocess, getNextParagraphInHeading, getPageNumber, getParentCell, getPositioningType, getPosX, getPosY, getRealPageNumber, getReferenceParagraphID, getRefPara, getSection, getTop, getVerticalPosInfo, getWidth, isDisabled, isEndNote, isFirstParagraph, isFirstParagraphInColumn, isFootNote, isFootNoteProcessed, isInHeaderFooter, isInList, isKeptTogether, isKeptWithNext, isOnOddPage, setEndNote, setFootNoteProcessed, setHeight, setID, setIsDisabled, setIsFirstParagraph, setIsFirstParagraphInColumn, setIsFootNote, setIsInHeaderFooter, setIsInList, setIsKeptTogether, setIsKeptWithNext, setIsNeedAddToPage, setIsOnOddPage, setIsPositionGot, setIsPositionProcessed, setLeft, setMargin, setMayNeedReprocess, setNeedReprocess, setNextParagraphInHeading, setPageNumber, setParentCell, setParentIsTable, setPositioningType, setPosX, setPosY, setRealPageNumber, setReferenceParagraphID, setRefPara, setSection, setTop, setVerticalPosInfo, setWidth |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DocumentAttachment
public DocumentAttachment()
- Constructor - initializes a new instance of the
DocumentAttachment class.
getDocumentAttachmentFile
public java.lang.String getDocumentAttachmentFile()
- Gets a String that indicates the
DocumentAttachment file name.
- Returns:
- A String value.
setDocumentAttachmentFile
public void setDocumentAttachmentFile(java.lang.String value)
- Sets a String that indicates the
DocumentAttachment file name.
- Parameters:
value - Attachment file name.
getDocumentAttachmentStream
public BinaryFileStream getDocumentAttachmentStream()
- Gets a stream attaches to the document.
- Returns:
- A
BinaryFileStream object.
setDocumentAttachmentStream
public void setDocumentAttachmentStream(BinaryFileStream value)
- Sets a stream attaches to the document.
- Parameters:
value - Attachment stream.
getDocumentAttachmentCotentType
public java.lang.String getDocumentAttachmentCotentType()
- Gets a String that indicates the MIME type of the attached file.
- Returns:
- A String value.
setDocumentAttachmentCotentType
public void setDocumentAttachmentCotentType(java.lang.String value)
- Sets a String that indicates the MIME type of the attached
- Parameters:
value - Attachment content type.
completeClone
public java.lang.Object completeClone()
- Specified by:
completeClone in class Paragraph
clone
public java.lang.Object clone()
- Overrides:
clone in class java.lang.Object