Class Document
Document class
代表一个Aspose.Note文档。
public class Document : CompositeNode<Page>, INotebookChildNode
构造函数
姓名 | 描述 |
---|---|
Document() | 初始化一个新的实例Document class. 创建一个空白的 OneNote 文档。 |
Document(Stream) | 初始化一个新的实例Document class. 从流中打开现有的 OneNote 文档。 |
Document(string) | 初始化一个新的实例Document class. 从文件中打开现有的 OneNote 文档。 |
Document(Stream, LoadOptions) | 初始化一个新的实例Document class. 从流中打开现有的 OneNote 文档。允许指定其他选项,例如加密密码。 |
Document(string, LoadOptions) | 初始化一个新的实例Document class. 从文件中打开现有的 OneNote 文档。允许指定其他选项,例如加密密码。 |
特性
姓名 | 描述 |
---|---|
AutomaticLayoutChangesDetectionEnabled { get; set; } | 获取或设置一个值,表示Aspose.Note是否自动检测布局变化。 默认值为真的 . |
Color { get; set; } | 获取或设置颜色。 |
CreationTime { get; set; } | 获取或设置创建时间。 |
DisplayName { get; set; } | 获取或设置显示名称。 |
Document { get; } | 获取节点的文档。 |
FileFormat { get; } | 获取文件格式(OneNote 2010、OneNote Online)。 |
FirstChild { get; } | |
Guid { get; } | 获取对象的全局唯一id。 |
IsComposite { get; } | |
LastChild { get; } | |
NextSibling { get; } | 获取同一节点树级别的下一个节点。 |
NodeType { get; } | 获取节点类型。 |
ParentNode { get; } | 获取父节点。 |
PreviousSibling { get; } | 获取同一节点树级别的前一个节点。 |
方法
姓名 | 描述 |
---|---|
override Accept(DocumentVisitor) | 接受节点的访问者。 |
virtual AppendChildFirst<T1>(T1) | |
virtual AppendChildLast<T1>(T1) | |
DetectLayoutChanges() | 检测自上次以来对文档布局所做的所有更改DetectLayoutChanges call. 万一AutomaticLayoutChangesDetectionEnabled 设置为 true,在文档导出开始时自动使用。 |
override GetChildNodes<T1>() | |
GetEnumerator() | |
GetPageHistory(Page) | 获取PageHistory 其中包含文档中出现的每个页面的完整历史记录(最早的索引为 0)。 当前页面修订可以访问为Current 并与历史版本的集合分开包含。 |
Import(Stream, PdfImportOptions, MergeOptions) | 从提供的 PDF 文档中导入一组页面。 |
Import(string, PdfImportOptions, MergeOptions) | 从提供的 PDF 文档中导入一组页面。 |
virtual InsertChild<T1>(int, T1) | |
InsertChildrenRange(int, IEnumerable<Page>) | |
InsertChildrenRange(int, params Page[]) | |
Merge(IEnumerable<Page>, MergeOptions) | 将一组页面合并到文档中。 |
Print() | 使用默认打印机打印文档。 |
Print(PrintOptions) | 使用默认打印机打印文档。 |
RemoveChild<T1>(T1) | |
Save(Stream) | 将 OneNote 文档保存到流中。 |
Save(string) | 将 OneNote 文档保存到文件中。 |
Save(Stream, SaveFormat) | 以指定格式将 OneNote 文档保存到流中。 |
Save(Stream, SaveOptions) | 使用指定的保存选项将 OneNote 文档保存到流中。 |
Save(string, SaveFormat) | 将 OneNote 文档保存为指定格式的文件。 |
Save(string, SaveOptions) | 使用指定的保存选项将 OneNote 文档保存到文件。 |
static IsEncrypted(Stream, out Document) | 检查流中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
static IsEncrypted(string, out Document) | 检查文件中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
static IsEncrypted(Stream, LoadOptions, out Document) | 检查流中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
static IsEncrypted(Stream, string, out Document) | 检查流中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
static IsEncrypted(string, LoadOptions, out Document) | 检查文件中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
static IsEncrypted(string, string, out Document) | 检查文件中的文档是否已加密。 要检查它,我们需要完全加载该文档。所以这种方法会导致性能下降。 |
例子
显示如何使用带有默认选项的标准 Windows 对话框将文档发送到打印机。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");
document.Print();
显示如何保存文档。
string inputFile = "Sample1.one";
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string outputFile = "SaveDocToOneNoteFormat_out.one";
Document doc = new Document(dataDir + inputFile);
doc.Save(dataDir + outputFile);
显示如何加密文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
LoadOptions loadOptions = new LoadOptions { DocumentPassword = "password" };
Document doc = new Document(dataDir + "Sample1.one", loadOptions);
显示如何使用加密保存文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_NoteBook();
Document document = new Document();
document.Save(dataDir + "CreatingPasswordProtectedDoc_out.one", new OneSaveOptions() { DocumentPassword = "pass" });
演示如何使用 SaveFormat 枚举保存文档。
string inputFile = "Sample1.one";
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string outputFile = "SaveDocToOneNoteFormatUsingSaveFormat_out.one";
Document document = new Document(dataDir + inputFile);
document.Save(dataDir + outputFile, SaveFormat.One);
演示如何使用 OneSaveOptions 保存文档。
string inputFile = "Sample1.one";
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string outputFile = "SaveDocToOneNoteFormatUsingOneSaveOptions_out.one";
Document document = new Document(dataDir + inputFile);
document.Save(dataDir + outputFile, new OneSaveOptions());
显示如何获取文档的页数。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 获取页数
int count = oneFile.Count();
// 在输出屏幕上打印计数
Console.WriteLine(count);
显示如何使用默认设置将文档保存为 pdf 格式。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 将文档保存为 PDF
dataDir = dataDir + "SaveWithDefaultSettings_out.pdf";
oneFile.Save(dataDir, SaveFormat.Pdf);
显示如何以 gif 格式保存文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
dataDir = dataDir + "SaveToImageDefaultOptions_out.gif";
// 将文档保存为 gif。
oneFile.Save(dataDir, SaveFormat.Gif);
显示将文档另存为 JPEG 格式图像时如何设置图像质量。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
dataDir = dataDir + "SetOutputImageResolution_out.jpg";
// 保存文档。
doc.Save(dataDir, new ImageSaveOptions(SaveFormat.Jpeg) { Quality = 100 });
显示将文档另存为图像时如何设置图像分辨率。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
dataDir = dataDir + "SetOutputImageResolution_out.jpg";
// 保存文档。
doc.Save(dataDir, new ImageSaveOptions(SaveFormat.Jpeg) { Resolution = 220 });
显示如何获取文档的文件格式。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");
switch (document.FileFormat)
{
case FileFormat.OneNote2010:
// 处理 OneNote 2010
break;
case FileFormat.OneNoteOnline:
// 在线处理 OneNote
break;
}
显示如何将超链接绑定到图像。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
var document = new Document();
var page = new Page(document);
var image = new Image(document, dataDir + "image.jpg") { HyperlinkUrl = "http://image.com" };
page.AppendChildLast(image);
document.AppendChildLast(page);
document.Save(dataDir + "Image with Hyperlink_out.one");
显示如何将文档保存到流中。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
MemoryStream dstStream = new MemoryStream();
doc.Save(dstStream, SaveFormat.Pdf);
// 将流位置倒回到零,以便为下一个读者做好准备。
dstStream.Seek(0, SeekOrigin.Begin);
显示如何检查文档是否受密码保护。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string fileName = Path.Combine(dataDir, "Aspose.one");
Document document;
if (!Document.IsEncrypted(fileName, out document))
{
Console.WriteLine("The document is loaded and ready to be processed.");
}
else
{
Console.WriteLine("The document is encrypted. Provide a password.");
}
演示如何向笔记本添加新部分。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_NoteBook();
// 加载一个 OneNote 笔记本
var notebook = new Notebook(dataDir + "Notizbuch �ffnen.onetoc2");
// 添加一个新的孩子到笔记本
notebook.AppendChild(new Document(dataDir + "Neuer Abschnitt 1.one"));
dataDir = dataDir + "AddChildNode_out.onetoc2";
// 保存笔记本
notebook.Save(dataDir);
显示如何检查文档加载是否因不支持 OneNote 2007 格式而失败。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string fileName = Path.Combine(dataDir, "OneNote2007.one");
try
{
new Document(fileName);
}
catch (UnsupportedFileFormatException e)
{
if (e.FileFormat == FileFormat.OneNote2007)
{
Console.WriteLine("It looks like the provided file is in OneNote 2007 format that is not supported.");
}
else
throw;
}
显示如何恢复页面的先前版本。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 加载 OneNote 文档并获取第一个子节点
Document document = new Document(dataDir + "Aspose.one");
Page page = document.FirstChild;
Page previousPageVersion = document.GetPageHistory(page).Last();
document.RemoveChild(page);
document.AppendChildLast(previousPageVersion);
document.Save(dataDir + "RollBackRevisions_out.one");
显示如何克隆页面。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 加载 OneNote 文档
Document document = new Document(dataDir + "Aspose.one", new LoadOptions { LoadHistory = true });
//克隆到没有历史记录的新文档
var cloned = new Document();
cloned.AppendChildLast(document.FirstChild.Clone());
// 克隆到具有历史记录的新文档
cloned = new Document();
cloned.AppendChildLast(document.FirstChild.Clone(true));
显示如何将文档保存为 html 格式,并将所有资源(css/字体/图像)存储到单独的文件中。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Document(Path.Combine(dataDir, "Aspose.one"));
var options = new HtmlSaveOptions()
{
ExportCss = ResourceExportType.ExportAsStream,
ExportFonts = ResourceExportType.ExportAsStream,
ExportImages = ResourceExportType.ExportAsStream,
FontFaceTypes = FontFaceType.Ttf
};
document.Save(dataDir + "document_out.html", options);
显示如何将文档保存到 html 格式的流中,并嵌入所有资源(css/字体/图像)。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Document(Path.Combine(dataDir, "Aspose.one"));
var options = new HtmlSaveOptions()
{
ExportCss = ResourceExportType.ExportEmbedded,
ExportFonts = ResourceExportType.ExportEmbedded,
ExportImages = ResourceExportType.ExportEmbedded,
FontFaceTypes = FontFaceType.Ttf
};
var r = new MemoryStream();
document.Save(r, options);
显示如何为图像设置文本描述。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
var document = new Document();
var page = new Page(document);
var image = new Image(document, dataDir + "image.jpg")
{
AlternativeTextTitle = "This is an image's title!",
AlternativeTextDescription = "And this is an image's description!"
};
page.AppendChildLast(image);
document.AppendChildLast(page);
dataDir = dataDir + "ImageAlternativeText_out.one";
document.Save(dataDir);
显示如何获取有关页面的元信息。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
foreach (Page page in oneFile)
{
Console.WriteLine("LastModifiedTime: {0}", page.LastModifiedTime);
Console.WriteLine("CreationTime: {0}", page.CreationTime);
Console.WriteLine("Title: {0}", page.Title);
Console.WriteLine("Level: {0}", page.Level);
Console.WriteLine("Author: {0}", page.Author);
Console.WriteLine();
}
当 OneNote 长页面以 pdf 格式保存时,它们会被拆分成多个页面。该示例展示了如何配置位于分页符处的对象的拆分逻辑。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
var pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm(100);
// 或者
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm(400);
dataDir = dataDir + "PageSplittUsingKeepPartAndCloneSolidObjectToNextPageAlgorithm_out.pdf";
doc.Save(dataDir);
显示如何以 png 格式保存文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 初始化 ImageSaveOptions 对象
ImageSaveOptions opts = new ImageSaveOptions(SaveFormat.Png)
{
// 设置页面索引
PageIndex = 1
};
dataDir = dataDir + "ConvertSpecificPageToImage_out.png";
// 将文档保存为 PNG。
oneFile.Save(dataDir, opts);
显示如何编辑页面的历史记录。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 加载 OneNote 文档并获取第一个子节点
Document document = new Document(dataDir + "Aspose.one");
Page page = document.FirstChild;
var pageHistory = document.GetPageHistory(page);
pageHistory.RemoveRange(0, 1);
pageHistory[0] = new Page(document);
if (pageHistory.Count > 1)
{
pageHistory[1].Title.TitleText.Text = "New Title";
pageHistory.Add(new Page(document));
pageHistory.Insert(1, new Page(document));
document.Save(dataDir + "ModifyPageHistory_out.one");
}
显示如何检查文档是否受特定密码的密码保护。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string fileName = Path.Combine(dataDir, "Aspose.one");
Document document;
if (Document.IsEncrypted(fileName, "VerySecretPassword", out document))
{
if (document != null)
{
Console.WriteLine("The document is decrypted. It is loaded and ready to be processed.");
}
else
{
Console.WriteLine("The document is encrypted. Invalid password was provided.");
}
}
else
{
Console.WriteLine("The document is NOT encrypted. It is loaded and ready to be processed.");
}
展示如何将深色主题样式应用于文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Text();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(Path.Combine(dataDir, "Aspose.one"));
foreach (var page in doc)
{
page.BackgroundColor = Color.Black;
}
foreach (var node in doc.GetChildNodes<RichText>())
{
var c = node.ParagraphStyle.FontColor;
if (c.IsEmpty || Math.Abs(c.R - Color.Black.R) + Math.Abs(c.G - Color.Black.G) + Math.Abs(c.B - Color.Black.B) <= 30)
{
node.ParagraphStyle.FontColor = Color.White;
}
}
doc.Save(Path.Combine(dataDir, "AsposeDarkTheme.pdf"));
显示如何传递笔记本的内容。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
string fileName = "Open Notebook.onetoc2";
try
{
var notebook = new Notebook(dataDir + fileName);
foreach (var notebookChildNode in notebook)
{
Console.WriteLine(notebookChildNode.DisplayName);
if (notebookChildNode is Document)
{
// 对子文档做一些事情
}
else if (notebookChildNode is Notebook)
{
// 用子笔记本做点什么
}
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
演示如何从文档中获取图像。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 获取所有Image节点
IList<Aspose.Note.Image> nodes = oneFile.GetChildNodes<Aspose.Note.Image>();
foreach (Aspose.Note.Image image in nodes)
{
using (MemoryStream stream = new MemoryStream(image.Bytes))
{
using (Bitmap bitMap = new Bitmap(stream))
{
// 将图像字节保存到文件
bitMap.Save(String.Format(dataDir + "{0}", Path.GetFileName(image.FileName)));
}
}
}
显示如何以 pdf 格式保存文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 初始化 PdfSaveOptions 对象
PdfSaveOptions opts = new PdfSaveOptions
{
// 设置要保存的第一页的页索引
PageIndex = 0,
// 设置页数
PageCount = 1,
};
// 将文档保存为 PDF
dataDir = dataDir + "SaveRangeOfPagesAsPDF_out.pdf";
oneFile.Save(dataDir, opts);
显示如何使用特定设置将文档保存为 pdf 格式。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
// 初始化 PdfSaveOptions 对象
PdfSaveOptions opts = new PdfSaveOptions
{
// 使用 Jpeg 压缩
ImageCompression = Saving.Pdf.PdfImageCompression.Jpeg,
// JPEG 压缩质量
JpegQuality = 90
};
dataDir = dataDir + "Document.SaveWithOptions_out.pdf";
doc.Save(dataDir, opts);
显示如何使用具有指定选项的标准 Windows 对话框将文档发送到打印机。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Aspose.Note.Document(dataDir + "Aspose.one");
var printerSettings = new PrinterSettings() { FromPage = 0, ToPage = 10 };
printerSettings.DefaultPageSettings.Landscape = true;
printerSettings.DefaultPageSettings.Margins = new System.Drawing.Printing.Margins(50, 50, 150, 50);
document.Print(new PrintOptions()
{
PrinterSettings = printerSettings,
Resolution = 1200,
PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm(),
DocumentName = "Test.one"
});
显示如何获取附加文件的内容。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Attachments();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Sample1.one");
// 获取附加文件节点列表
IList<AttachedFile> nodes = oneFile.GetChildNodes<AttachedFile>();
//遍历所有节点
foreach (AttachedFile file in nodes)
{
// 将附加文件加载到流对象
using (Stream outputStream = new MemoryStream(file.Bytes))
{
// 创建本地文件
using (Stream fileStream = System.IO.File.OpenWrite(String.Format(dataDir + file.FileName)))
{
// 复制文件流
CopyStream(outputStream, fileStream);
}
}
}
显示如何获取图像的元信息。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
// 将文档加载到 Aspose.Note 中。
Document oneFile = new Document(dataDir + "Aspose.one");
// 获取所有Image节点
IList<Aspose.Note.Image> images = oneFile.GetChildNodes<Aspose.Note.Image>();
foreach (Aspose.Note.Image image in images)
{
Console.WriteLine("Width: {0}", image.Width);
Console.WriteLine("Height: {0}", image.Height);
Console.WriteLine("OriginalWidth: {0}", image.OriginalWidth);
Console.WriteLine("OriginalHeight: {0}", image.OriginalHeight);
Console.WriteLine("FileName: {0}", image.FileName);
Console.WriteLine("LastModifiedTime: {0}", image.LastModifiedTime);
Console.WriteLine();
}
显示如何获取页面的历史记录。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Pages();
// 加载 OneNote 文档
Document document = new Document(dataDir + "Aspose.one", new LoadOptions { LoadHistory = true });
// 获取第一页
Page firstPage = document.FirstChild;
foreach (Page pageRevision in document.GetPageHistory(firstPage))
{
/*Use pageRevision like a regular page.*/
Console.WriteLine("LastModifiedTime: {0}", pageRevision.LastModifiedTime);
Console.WriteLine("CreationTime: {0}", pageRevision.CreationTime);
Console.WriteLine("Title: {0}", pageRevision.Title);
Console.WriteLine("Level: {0}", pageRevision.Level);
Console.WriteLine("Author: {0}", pageRevision.Author);
Console.WriteLine();
}
演示如何使用文件路径将文件添加到文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Attachments();
// 创建文档类的对象
Document doc = new Document();
// 初始化页面类对象
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// 初始化大纲类对象
Outline outline = new Outline(doc);
// 初始化 OutlineElement 类对象
OutlineElement outlineElem = new OutlineElement(doc);
// 初始化 AttachedFile 类对象
AttachedFile attachedFile = new AttachedFile(doc, dataDir + "attachment.txt");
// 添加附件
outlineElem.AppendChildLast(attachedFile);
// 添加轮廓元素节点
outline.AppendChildLast(outlineElem);
// 添加轮廓节点
page.AppendChildLast(outline);
// 添加页面节点
doc.AppendChildLast(page);
dataDir = dataDir + "AttachFileByPath_out.one";
doc.Save(dataDir);
显示如何使用默认选项创建文档并将其保存为 html 格式。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 初始化 OneNote 文档
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// 文档中所有文本的默认样式。
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// 保存成HTML格式
dataDir = dataDir + "CreateOneNoteDocAndSaveToHTML_out.html";
doc.Save(dataDir);
显示如何检查页面是否为冲突页面(即它具有 OneNote 无法自动合并的更改)。
string dataDir = RunExamples.GetDataDir_Pages();
// 加载 OneNote 文档
Document doc = new Document(dataDir + "Aspose.one", new LoadOptions { LoadHistory = true });
var history = doc.GetPageHistory(doc.FirstChild);
for (int i = 0; i < history.Count; i++)
{
var historyPage = history[i];
Console.Write(" {0}. Author: {1}, {2:dd.MM.yyyy hh.mm.ss}",
i,
historyPage.PageContentRevisionSummary.AuthorMostRecent,
historyPage.PageContentRevisionSummary.LastModifiedTime);
Console.WriteLine(historyPage.IsConflictPage ? ", IsConflict: true" : string.Empty);
// 默认情况下,冲突页面只是在保存时被跳过。
// 如果将其标记为非冲突,则它将照常保存在历史记录中。
if (historyPage.IsConflictPage)
historyPage.IsConflictPage = false;
}
doc.Save(dataDir + "ConflictPageManipulation_out.one", SaveFormat.One);
显示如何将图像从文件添加到具有用户定义属性的文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
// 从流中加载文档。
Document doc = new Document(dataDir + "Aspose.one");
// 获取文档的第一页。
Aspose.Note.Page page = doc.FirstChild;
// 从文件中加载图像。
Aspose.Note.Image image = new Aspose.Note.Image(doc, dataDir + "image.jpg")
{
// 根据需要更改图像的大小(可选)。
Width = 100,
Height = 100,
// 设置图像在页面中的位置(可选)。
HorizontalOffset = 100,
VerticalOffset = 400,
// 设置图像对齐
Alignment = HorizontalAlignment.Right
};
// 将图像添加到页面。
page.AppendChildLast(image);
演示如何将文件从流添加到文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Attachments();
// 创建文档类的对象
Document doc = new Document();
// 初始化页面类对象
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// 初始化大纲类对象
Outline outline = new Outline(doc);
// 初始化 OutlineElement 类对象
OutlineElement outlineElem = new OutlineElement(doc);
using (var stream = File.OpenRead(dataDir + "icon.jpg"))
{
// 初始化 AttachedFile 类对象并传递其图标路径
AttachedFile attachedFile = new AttachedFile(doc, dataDir + "attachment.txt", stream, ImageFormat.Jpeg);
// 添加附件
outlineElem.AppendChildLast(attachedFile);
}
// 添加轮廓元素节点
outline.AppendChildLast(outlineElem);
// 添加轮廓节点
page.AppendChildLast(outline);
// 添加页面节点
doc.AppendChildLast(page);
dataDir = dataDir + "AttachFileAndSetIcon_out.one";
doc.Save(dataDir);
当 OneNote 长页面以 pdf 格式保存时,它们会被拆分成多个页面。该示例显示如何配置位于分页符处的对象的拆分逻辑。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 将文档加载到 Aspose.Note 中。
Document doc = new Document(dataDir + "Aspose.one");
var pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.PageSplittingAlgorithm = new AlwaysSplitObjectsAlgorithm();
// 或者
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm();
// 或者
pdfSaveOptions.PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm();
float heightLimitOfClonedPart = 500;
pdfSaveOptions.PageSplittingAlgorithm = new KeepPartAndCloneSolidObjectToNextPageAlgorithm(heightLimitOfClonedPart);
// 或者
pdfSaveOptions.PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm(heightLimitOfClonedPart);
pdfSaveOptions.PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm(100);
// 或者
pdfSaveOptions.PageSplittingAlgorithm = new KeepSolidObjectsAlgorithm(400);
dataDir = dataDir + "UsingKeepSOlidObjectsAlgorithm_out.pdf";
doc.Save(dataDir);
显示如何创建文档并以 html 格式保存指定范围的页面。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 初始化 OneNote 文档
Document doc = new Document();
Page page = doc.AppendChildLast(new Page());
// 文档中所有文本的默认样式。
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title()
{
TitleText = new RichText() { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText() { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText() { Text = "12:34", ParagraphStyle = textStyle }
};
// 保存成HTML格式
dataDir = dataDir + "CreateAndSavePageRange_out.html";
doc.Save(dataDir, new HtmlSaveOptions
{
PageCount = 1,
PageIndex = 0
});
显示如何创建带标题页面的文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 创建文档类的对象
Document doc = new Aspose.Note.Document();
// 初始化页面类对象
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// 文档中所有文本的默认样式。
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// 设置页面标题属性
page.Title = new Title(doc)
{
TitleText = new RichText(doc) { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText(doc) { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText(doc) { Text = "12:34", ParagraphStyle = textStyle }
};
// 在文档中追加页面节点
doc.AppendChildLast(page);
// 保存 OneNote 文档
dataDir = dataDir + "CreateDocWithPageTitle_out.one";
doc.Save(dataDir);
显示如何将图像从流添加到文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
// 创建文档类的对象
Document doc = new Document();
// 初始化页面类对象
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline1 = new Outline(doc);
OutlineElement outlineElem1 = new OutlineElement(doc);
using (FileStream fs = File.OpenRead(dataDir + "image.jpg"))
{
// 使用图片名称、扩展名和流加载第二张图片。
Aspose.Note.Image image1 = new Aspose.Note.Image(doc, "Penguins.jpg", fs)
{
// 设置图像对齐
Alignment = HorizontalAlignment.Right
};
outlineElem1.AppendChildLast(image1);
}
outline1.AppendChildLast(outlineElem1);
page.AppendChildLast(outline1);
doc.AppendChildLast(page);
// 保存 OneNote 文档
dataDir = dataDir + "BuildDocAndInsertImageUsingImageStream_out.one";
doc.Save(dataDir);
显示如何将图像从文件添加到文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Images();
// 创建文档类的对象
Document doc = new Document();
// 初始化页面类对象
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// 初始化 Outline 类对象并设置偏移量属性
Outline outline = new Outline(doc);
// 初始化 OutlineElement 类对象
OutlineElement outlineElem = new OutlineElement(doc);
// 通过文件路径加载图像。
Aspose.Note.Image image = new Aspose.Note.Image(doc, dataDir + "image.jpg")
{
// 设置图像对齐
Alignment = HorizontalAlignment.Right
};
// 添加图片
outlineElem.AppendChildLast(image);
// 添加轮廓元素
outline.AppendChildLast(outlineElem);
// 添加轮廓节点
page.AppendChildLast(outline);
// 添加页面节点
doc.AppendChildLast(page);
// 保存 OneNote 文档
dataDir = dataDir + "BuildDocAndInsertImage_out.one";
doc.Save(dataDir);
显示如何创建带有文本的文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 创建文档类的对象
Document doc = new Document();
// 初始化页面类对象
Page page = new Page(doc);
// 初始化大纲类对象
Outline outline = new Outline(doc);
// 初始化 OutlineElement 类对象
OutlineElement outlineElem = new OutlineElement(doc);
// 初始化 TextStyle 类对象并设置格式属性
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// 初始化 RichText 类对象并应用文本样式
RichText text = new RichText(doc) { Text = "Hello OneNote text!", ParagraphStyle = textStyle };
// 添加 RichText 节点
outlineElem.AppendChildLast(text);
// 添加 OutlineElement 节点
outline.AppendChildLast(outlineElem);
// 添加轮廓节点
page.AppendChildLast(outline);
// 添加页面节点
doc.AppendChildLast(page);
// 保存 OneNote 文档
dataDir = dataDir + "CreateDocWithSimpleRichText_out.one";
doc.Save(dataDir);
显示如何以不同格式保存文档。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 初始化新文档
Document doc = new Document() { AutomaticLayoutChangesDetectionEnabled = false };
// 初始化新页面
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// 文档中所有文本的默认样式。
ParagraphStyle textStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
page.Title = new Title(doc)
{
TitleText = new RichText(doc) { Text = "Title text.", ParagraphStyle = textStyle },
TitleDate = new RichText(doc) { Text = new DateTime(2011, 11, 11).ToString("D", CultureInfo.InvariantCulture), ParagraphStyle = textStyle },
TitleTime = new RichText(doc) { Text = "12:34", ParagraphStyle = textStyle }
};
//追加页面节点
doc.AppendChildLast(page);
// 以不同格式保存 OneNote 文档,手动设置文本字体大小和检测布局变化。
doc.Save(dataDir + "ConsequentExportOperations_out.html");
doc.Save(dataDir + "ConsequentExportOperations_out.pdf");
doc.Save(dataDir + "ConsequentExportOperations_out.jpg");
textStyle.FontSize = 11;
doc.DetectLayoutChanges();
doc.Save(dataDir + "ConsequentExportOperations_out.bmp");
显示如何使用用户定义的回调以 html 格式保存文档并存储所有资源(css/字体/图像)。
// 下面的代码创建包含 document.html 的“documentFolder”文件夹、包含“style.css”文件的“css”文件夹、包含图像的“images”文件夹和包含字体的“fonts”文件夹。
// 'style.css' 文件将在末尾包含以下字符串“/* This line is appended to stream manually by user */”
var savingCallbacks = new UserSavingCallbacks()
{
RootFolder = "documentFolder",
CssFolder = "css",
KeepCssStreamOpened = true,
ImagesFolder = "images",
FontsFolder = "fonts"
};
var options = new HtmlSaveOptions
{
FontFaceTypes = FontFaceType.Ttf,
CssSavingCallback = savingCallbacks,
FontSavingCallback = savingCallbacks,
ImageSavingCallback = savingCallbacks
};
if (!Directory.Exists(savingCallbacks.RootFolder))
{
Directory.CreateDirectory(savingCallbacks.RootFolder);
}
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
var document = new Document(Path.Combine(dataDir, "Aspose.one"));
using (var stream = File.Create(Path.Combine(savingCallbacks.RootFolder, "document.html")))
{
document.Save(stream, options);
}
using (var writer = new StreamWriter(savingCallbacks.CssStream))
{
writer.WriteLine();
writer.WriteLine("/* This line is appended to stream manually by user */");
}
显示如何将超链接绑定到文本。
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_Tasks();
// 创建文档类的对象
Document doc = new Document();
RichText titleText = new RichText() { ParagraphStyle = ParagraphStyle.Default }.Append("Title!");
Outline outline = new Outline()
{
MaxWidth = 200,
MaxHeight = 200,
VerticalOffset = 100,
HorizontalOffset = 100
};
TextStyle textStyleRed = new TextStyle
{
FontColor = Color.Red,
FontName = "Arial",
FontSize = 10,
};
TextStyle textStyleHyperlink = new TextStyle
{
IsHyperlink = true,
HyperlinkAddress = "www.google.com"
};
RichText text = new RichText() { ParagraphStyle = ParagraphStyle.Default }
.Append("This is ", textStyleRed)
.Append("hyperlink", textStyleHyperlink)
.Append(". This text is not a hyperlink.", TextStyle.Default);
OutlineElement outlineElem = new OutlineElement();
outlineElem.AppendChildLast(text);
// 添加轮廓元素
outline.AppendChildLast(outlineElem);
// 初始化标题类对象
Title title = new Title() { TitleText = titleText };
// 初始化页面类对象
Page page = new Note.Page() { Title = title };
// 添加轮廓节点
page.AppendChildLast(outline);
// 添加页面节点
doc.AppendChildLast(page);
// 保存 OneNote 文档
dataDir = dataDir + "AddHyperlink_out.one";
doc.Save(dataDir);
显示如何使用访问者访问文档的内容。
public static void Run()
{
// 文档目录的路径。
string dataDir = RunExamples.GetDataDir_LoadingAndSaving();
// 打开我们要转换的文档。
Document doc = new Document(dataDir + "Aspose.one");
// 创建一个继承自 DocumentVisitor 类的对象。
MyOneNoteToTxtWriter myConverter = new MyOneNoteToTxtWriter();
// 这是众所周知的访客模式。让模型接受访客。
// 模型将通过调用相应的方法来遍历自身
// 在访问者对象上(这称为访问)。
//
// 请注意,对象模型中的每个节点都有 Accept 方法,因此访问
// 不仅可以对整个文档执行,还可以对文档中的任何节点执行。
doc.Accept(myConverter);
// 一旦访问完成,我们就可以检索操作的结果,
// 在此示例中,已在访问者中积累。
Console.WriteLine(myConverter.GetText());
Console.WriteLine(myConverter.NodeCount);
}
/// <summary>
/// 以纯文本格式保存文档的简单实现。作为访客实施。
/// </summary>
public class MyOneNoteToTxtWriter : DocumentVisitor
{
public MyOneNoteToTxtWriter()
{
nodecount = 0;
mIsSkipText = false;
mBuilder = new StringBuilder();
}
/// <summary>
/// 获取访问者积累的文档的纯文本。
/// </summary>
public string GetText()
{
return mBuilder.ToString();
}
/// <summary>
/// 将文本添加到当前输出。尊重启用/禁用的输出标志。
/// </summary>
private void AppendText(string text)
{
if (!mIsSkipText)
{
mBuilder.AppendLine(text);
}
}
/// <summary>
/// 在文档中遇到 RichText 节点时调用。
/// </summary>
public override void VisitRichTextStart(RichText run)
{
++nodecount;
AppendText(run.Text);
}
/// <summary>
/// 在文档中遇到文档节点时调用。
/// </summary>
public override void VisitDocumentStart(Document document)
{
++nodecount;
}
/// <summary>
/// 在文档中遇到页面节点时调用。
/// </summary>
public override void VisitPageStart(Page page)
{
++nodecount;
this.AppendText($"*** Page '{page.Title?.TitleText?.Text ?? "(no title)"}' ***");
}
/// <summary>
/// 当页面节点的处理完成时调用。
/// </summary>
public override void VisitPageEnd(Page page)
{
this.AppendText(string.Empty);
}
/// <summary>
/// 在文档中遇到标题节点时调用。
/// </summary>
public override void VisitTitleStart(Title title)
{
++nodecount;
}
/// <summary>
/// 在文档中遇到图像节点时调用。
/// </summary>
public override void VisitImageStart(Image image)
{
++nodecount;
}
/// <summary>
/// 在文档中遇到 OutlineGroup 节点时调用。
/// </summary>
public override void VisitOutlineGroupStart(OutlineGroup outlineGroup)
{
++nodecount;
}
/// <summary>
/// 在文档中遇到大纲节点时调用。
/// </summary>
public override void VisitOutlineStart(Outline outline)
{
++nodecount;
}
/// <summary>
/// 在文档中遇到 OutlineElement 节点时调用。
/// </summary>
public override void VisitOutlineElementStart(OutlineElement outlineElement)
{
++nodecount;
}
/// <summary>
/// 获取访问者的节点总数
/// </summary>
public Int32 NodeCount
{
get { return this.nodecount; }
}
private readonly StringBuilder mBuilder;
private bool mIsSkipText;
private Int32 nodecount;
}
也可以看看
- class CompositeNode<T>
- class Page
- interface INotebookChildNode
- 命名空间 Aspose.Note
- 部件 Aspose.Note