DocumentPartSavingArgs
内容
[
隐藏
]DocumentPartSavingArgs class
提供数据DocumentPartSaving
回调.
要了解更多信息,请访问保存文档文档文章。
public class DocumentPartSavingArgs
特性
姓名 | 描述 |
---|---|
Document { get; } | 获取正在保存的文档对象。 |
DocumentPartFileName { get; set; } | 获取或设置文档部分将保存到的文件名(不带路径)。 |
DocumentPartStream { get; set; } | 允许指定文档部分将保存到的流。 |
KeepDocumentPartStreamOpen { get; set; } | 指定 Aspose.Words 在保存文档部分后是否应保持流打开或关闭它。 |
评论
当 Aspose.Words 将文档保存为 HTML 或相关格式并DocumentSplitCriteria
指定 时,文档将被拆分为多个部分,并且默认情况下,每个文档部分都保存到单独的文件中。
班级DocumentPartSavingArgs
允许您控制每个文档部分的保存方式。 它允许重新定义文件名的生成方式,或者通过提供您自己的流对象来完全避免将文档部分保存到 文件中。
要将文档部分保存到流而不是文件中,请使用DocumentPartStream
财产。
例子
演示如何将文档拆分为多个部分并保存它们。
public void DocumentPartsFileNames()
{
Document doc = new Document(MyDir + "Rendering.docx");
string outFileName = "SavingCallback.DocumentPartsFileNames.html";
// 创建一个“HtmlFixedSaveOptions”对象,我们可以将其传递给文档的“Save”方法
// 修改我们将文档转换为 HTML 的方式。
HtmlSaveOptions options = new HtmlSaveOptions();
// 如果我们正常保存文档,将会有一个输出 HTML
// 包含所有源文档内容的文档。
// 将“DocumentSplitCriteria”属性设置为“DocumentSplitCriteria.SectionBreak”
// 将我们的文档保存到多个 HTML 文件:每个部分一个。
options.DocumentSplitCriteria = DocumentSplitCriteria.SectionBreak;
// 将自定义回调分配给“DocumentPartSavingCallback”属性以更改文档部分保存逻辑。
options.DocumentPartSavingCallback = new SavedDocumentPartRename(outFileName, options.DocumentSplitCriteria);
// 如果我们将包含图像的文档转换为 html,我们最终会得到一个链接到多个图像的 html 文件。
// 每个图像将以文件的形式存在于本地文件系统中。
// 还有一个回调可以自定义每个图像的名称和文件系统位置。
options.ImageSavingCallback = new SavedImageRename(outFileName);
doc.Save(ArtifactsDir + outFileName, options);
}
/// <summary>
/// 设置保存操作将文档分割成的输出文档的自定义文件名。
/// </summary>
private class SavedDocumentPartRename : IDocumentPartSavingCallback
{
public SavedDocumentPartRename(string outFileName, DocumentSplitCriteria documentSplitCriteria)
{
mOutFileName = outFileName;
mDocumentSplitCriteria = documentSplitCriteria;
}
void IDocumentPartSavingCallback.DocumentPartSaving(DocumentPartSavingArgs args)
{
// 我们可以通过“Document”属性访问整个源文档。
Assert.True(args.Document.OriginalFileName.EndsWith("Rendering.docx"));
string partType = string.Empty;
switch (mDocumentSplitCriteria)
{
case DocumentSplitCriteria.PageBreak:
partType = "Page";
break;
case DocumentSplitCriteria.ColumnBreak:
partType = "Column";
break;
case DocumentSplitCriteria.SectionBreak:
partType = "Section";
break;
case DocumentSplitCriteria.HeadingParagraph:
partType = "Paragraph from heading";
break;
}
string partFileName = $"{mOutFileName} part {++mCount}, of type {partType}{Path.GetExtension(args.DocumentPartFileName)}";
// 以下是指定 Aspose.Words 保存文档各部分的位置的两种方法。
// 1 - 设置输出零件文件的文件名:
args.DocumentPartFileName = partFileName;
// 2 - 为输出零件文件创建自定义流:
args.DocumentPartStream = new FileStream(ArtifactsDir + partFileName, FileMode.Create);
Assert.True(args.DocumentPartStream.CanWrite);
Assert.False(args.KeepDocumentPartStreamOpen);
}
private int mCount;
private readonly string mOutFileName;
private readonly DocumentSplitCriteria mDocumentSplitCriteria;
}
/// <summary>
/// 为 HTML 转换创建的图像文件设置自定义文件名。
/// </summary>
public class SavedImageRename : IImageSavingCallback
{
public SavedImageRename(string outFileName)
{
mOutFileName = outFileName;
}
void IImageSavingCallback.ImageSaving(ImageSavingArgs args)
{
string imageFileName = $"{mOutFileName} shape {++mCount}, of type {args.CurrentShape.ShapeType}{Path.GetExtension(args.ImageFileName)}";
// 以下是指定 Aspose.Words 保存文档各部分的位置的两种方法。
// 1 - 设置输出图像文件的文件名:
args.ImageFileName = imageFileName;
// 2 - 为输出图像文件创建自定义流:
args.ImageStream = new FileStream(ArtifactsDir + imageFileName, FileMode.Create);
Assert.True(args.ImageStream.CanWrite);
Assert.True(args.IsImageAvailable);
Assert.False(args.KeepImageStreamOpen);
}
private int mCount;
private readonly string mOutFileName;
}
也可以看看
- 命名空间 Aspose.Words.Saving
- 部件 Aspose.Words