ImageData

ImageData class

为形状定义图像。

public class ImageData

特性

姓名 描述
BiLevel { get; set; } 确定图像是否以黑白显示。
Borders { get; } 获取图像边框的集合。边框仅对内联图像有效。
Brightness { get; set; } 获取或设置图片的亮度。 该属性的值必须是从 0.0（最暗）到 1.0（最亮）的数字。
ChromaKey { get; set; } 定义将被视为透明的图像的颜色值。
Contrast { get; set; } 获取或设置指定图片的对比度。此属性的 value 必须是从 0.0（最小对比度）到 1.0（最大对比度）的数字。
CropBottom { get; set; } 定义图片从底部移除的比例。
CropLeft { get; set; } 定义图片从左侧移除的分数。
CropRight { get; set; } 定义图片从右侧移除的分数。
CropTop { get; set; } 定义从顶部移除图片的比例。
GrayScale { get; set; } 确定图片是否以灰度模式显示。
HasImage { get; } 如果形状具有图像字节或链接图像，则返回 true。
ImageBytes { get; set; } 获取或设置存储在 shape 中的图像的原始字节数。
ImageSize { get; } 获取有关图像大小和分辨率的信息。
ImageType { get; } 获取图像的类型。
IsLink { get; } 如果图像链接到形状，则返回 true（当SourceFullName已指定）.
IsLinkOnly { get; } 如果图像已链接且未存储在文档中，则返回 true。
SourceFullName { get; set; } 获取或设置链接图像的源文件的路径和名称。
Title { get; set; } 定义图像的标题。

方法

姓名 描述
Save(Stream) 将图像保存到指定的流中。
Save(string) 将图像保存到文件中。
SetImage(Image) 设置形状显示的图像。
SetImage(Stream) 设置形状显示的图像。
SetImage(string) 设置形状显示的图像。
ToByteArray() 返回任何图像的图像字节，无论图像是存储还是链接。
ToImage() 获取存储在形状中的图像作为Image对象.
ToStream() 创建并返回一个包含图像字节的流。

评论

使用ImageData属性来访问和修改形状内的图像。 您不创建的实例ImageData直接上课。

图像可以存储在形状内，链接到外部文件或两者（链接并存储在文档中）。

无论图像是存储在形状内还是链接，您始终可以使用实际 图像ToByteArray,ToStream,ToImage或者Savemethods. 如果图像存储在形状内，您也可以使用ImageBytes财产。

要将图像存储在形状中，请使用SetImage方法。要将图像链接到形状，请将SourceFullName财产。

例子

演示如何从文档中提取图像，并将它们作为单独的文件保存到本地文件系统。

Document doc = new Document(MyDir + "Images.docx");

// 从文档中获取形状的集合，
// 并将每个形状的图像数据与图像一起作为文件保存到本地文件系统。
NodeCollection shapes = doc.GetChildNodes(NodeType.Shape, true);

Assert.AreEqual(9, shapes.Count(s => ((Shape)s).HasImage));

int imageIndex = 0;
foreach (Shape shape in shapes.OfType<Shape>())
{
    if (shape.HasImage)
    {
        // 形状的图像数据可能包含多种可能的图像格式的图像。 
        // 我们可以根据图像的格式自动确定每个图像的文件扩展名。
        string imageFileName =
            $"File.ExtractImages.{imageIndex}{FileFormatUtil.ImageTypeToExtension(shape.ImageData.ImageType)}";
        shape.ImageData.Save(ArtifactsDir + imageFileName);
        imageIndex++;
    }
}

演示如何将链接图像插入到文档中。

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

string imageFileName = ImageDir + "Windows MetaFile.wmf";

// 下面是两种将图像应用到形状以便显示它的方法。
// 1 - 设置包含图像的形状。
Shape shape = new Shape(builder.Document, ShapeType.Image);
shape.WrapType = WrapType.Inline;
shape.ImageData.SetImage(imageFileName);

builder.InsertNode(shape);

doc.Save(ArtifactsDir + "Image.CreateLinkedImage.Embedded.docx");

// 我们以形状存储的每个图像都会增加文档的大小。
Assert.True(70000 < new FileInfo(ArtifactsDir + "Image.CreateLinkedImage.Embedded.docx").Length);

doc.FirstSection.Body.FirstParagraph.RemoveAllChildren();

// 2 - 将形状设置为链接到本地文件系统中的图像文件。
shape = new Shape(builder.Document, ShapeType.Image);
shape.WrapType = WrapType.Inline;
shape.ImageData.SourceFullName = imageFileName;

builder.InsertNode(shape);
doc.Save(ArtifactsDir + "Image.CreateLinkedImage.Linked.docx");

// 链接到图像将节省空间并导致文档更小。
// 但是，文档只能正确显示图像，而
// 图像文件存在于形状的“SourceFullName”属性指向的位置。
Assert.True(10000 > new FileInfo(ArtifactsDir + "Image.CreateLinkedImage.Linked.docx").Length);

也可以看看

HorizontalRuleFormat ImageSize