public void DetectFileFormat_EnumConversions()
{
//ExStart
//ExFor:FileFormatUtil.DetectFileFormat(Stream)
//ExFor:FileFormatUtil.LoadFormatToExtension(LoadFormat)
//ExFor:FileFormatUtil.ExtensionToSaveFormat(String)
//ExFor:FileFormatUtil.SaveFormatToExtension(SaveFormat)
//ExFor:FileFormatUtil.LoadFormatToSaveFormat(LoadFormat)
//ExFor:Document.OriginalFileName
//ExFor:FileFormatInfo.LoadFormat
//ExSummary:Shows how to use the FileFormatUtil methods to detect the format of a document without any extension and save it with the correct file extension.
// Load the document without a file extension into a stream and use the DetectFileFormat method to detect it's format.
// These are both times where you might need extract the file format as it's not visible
FileStream
docStream = File.OpenRead(
MyDir + "Document.FileWithoutExtension"); // The file format of this document is actually ".doc"
FileFormatInfo info = FileFormatUtil.DetectFileFormat(docStream);
// Retrieve the LoadFormat of the document.
LoadFormat loadFormat = info.LoadFormat;
// Let's show the different methods of converting LoadFormat enumerations to SaveFormat enumerations.
//
// Method #1
// Convert the LoadFormat to a String first for working with. The String will include the leading dot in front of the extension.
String fileExtension = FileFormatUtil.LoadFormatToExtension(loadFormat);
// Now convert this extension into the corresponding SaveFormat enumeration
SaveFormat saveFormat = FileFormatUtil.ExtensionToSaveFormat(fileExtension);
// Method #2
// Convert the LoadFormat enumeration directly to the SaveFormat enumeration.
saveFormat = FileFormatUtil.LoadFormatToSaveFormat(loadFormat);
// Load a document from the stream.
Document doc = new Document(docStream);
// Save the document with the original file name, " Out" and the document's file extension.
doc.Save(
ArtifactsDir + "Document.WithFileExtension" + FileFormatUtil.SaveFormatToExtension(saveFormat));
//ExEnd
Assert.AreEqual(".doc", FileFormatUtil.SaveFormatToExtension(saveFormat));
}
public void SaveToDetectedFileFormat()
{
//ExStart
//ExFor:FileFormatUtil.DetectFileFormat(Stream)
//ExFor:FileFormatUtil.LoadFormatToExtension(LoadFormat)
//ExFor:FileFormatUtil.ExtensionToSaveFormat(String)
//ExFor:FileFormatUtil.SaveFormatToExtension(SaveFormat)
//ExFor:FileFormatUtil.LoadFormatToSaveFormat(LoadFormat)
//ExFor:Document.OriginalFileName
//ExFor:FileFormatInfo.LoadFormat
//ExFor:LoadFormat
//ExSummary:Shows how to use the FileFormatUtil methods to detect the format of a document.
// Load a document from a file that is missing a file extension, and then detect its file format.
using (FileStream docStream = File.OpenRead(MyDir + "Word document with missing file extension"))
{
FileFormatInfo info = FileFormatUtil.DetectFileFormat(docStream);
LoadFormat loadFormat = info.LoadFormat;
Assert.AreEqual(LoadFormat.Doc, loadFormat);
// Below are two methods of converting a LoadFormat to its corresponding SaveFormat.
// 1 - Get the file extension string for the LoadFormat, then get the corresponding SaveFormat from that string:
string fileExtension = FileFormatUtil.LoadFormatToExtension(loadFormat);
SaveFormat saveFormat = FileFormatUtil.ExtensionToSaveFormat(fileExtension);
// 2 - Convert the LoadFormat directly to its SaveFormat:
saveFormat = FileFormatUtil.LoadFormatToSaveFormat(loadFormat);
// Load a document from the stream, and then save it to the automatically detected file extension.
Document doc = new Document(docStream);
Assert.AreEqual(".doc", FileFormatUtil.SaveFormatToExtension(saveFormat));
doc.Save(ArtifactsDir + "File.SaveToDetectedFileFormat" + FileFormatUtil.SaveFormatToExtension(saveFormat));
}
//ExEnd
}
/// <summary>
/// Renders any node in a document to the path specified using the image save options.
/// </summary>
/// <param name="node">The node to render.</param>
/// <param name="filePath">The path to save the rendered image to.</param>
/// <param name="imageOptions">The image options to use during rendering. This can be null.</param>
public void RenderNode(Node node, string filePath, ImageSaveOptions imageOptions)
{
if (imageOptions == null)
{
imageOptions = new ImageSaveOptions(FileFormatUtil.ExtensionToSaveFormat(Path.GetExtension(filePath)));
}
// Store the paper color to be used on the final image and change to transparent.
// This will cause any content around the rendered node to be removed later on.
Color savePaperColor = imageOptions.PaperColor;
imageOptions.PaperColor = Color.Transparent;
// There a bug which affects the cache of a cloned node.
// To avoid this, we clone the entire document, including all nodes,
// finding the matching node in the cloned document and rendering that instead.
Document doc = (Document)node.Document.Clone(true);
node = doc.GetChild(NodeType.Any, node.Document.GetChildNodes(NodeType.Any, true).IndexOf(node), true);
// Create a temporary shape to store the target node in. This shape will be rendered to retrieve
// the rendered content of the node.
Shape shape = new Shape(doc, ShapeType.TextBox);
Section parentSection = (Section)node.GetAncestor(NodeType.Section);
// Assume that the node cannot be larger than the page in size.
shape.Width = parentSection.PageSetup.PageWidth;
shape.Height = parentSection.PageSetup.PageHeight;
shape.FillColor = Color.Transparent;
// Don't draw a surronding line on the shape.
shape.Stroked = false;
// Move up through the DOM until we find a suitable node to insert into a Shape
// (a node with a parent can contain paragraphs, tables the same as a shape). Each parent node is cloned
// on the way up so even a descendant node passed to this method can be rendered. Since we are working
// with the actual nodes of the document we need to clone the target node into the temporary shape.
Node currentNode = node;
while (!(currentNode.ParentNode is InlineStory || currentNode.ParentNode is Story ||
currentNode.ParentNode is ShapeBase))
{
CompositeNode parent = (CompositeNode)currentNode.ParentNode.Clone(false);
currentNode = currentNode.ParentNode;
parent.AppendChild(node.Clone(true));
node = parent; // Store this new node to be inserted into the shape.
}
// We must add the shape to the document tree to have it rendered.
shape.AppendChild(node.Clone(true));
parentSection.Body.FirstParagraph.AppendChild(shape);
// Render the shape to stream so we can take advantage of the effects of the ImageSaveOptions class.
// Retrieve the rendered image and remove the shape from the document.
MemoryStream stream = new MemoryStream();
ShapeRenderer renderer = shape.GetShapeRenderer();
renderer.Save(stream, imageOptions);
shape.Remove();
Rectangle crop = renderer.GetOpaqueBoundsInPixels(imageOptions.Scale, imageOptions.HorizontalResolution,
imageOptions.VerticalResolution);
using (Bitmap renderedImage = new Bitmap(stream))
{
Bitmap croppedImage = new Bitmap(crop.Width, crop.Height);
croppedImage.SetResolution(imageOptions.HorizontalResolution, imageOptions.VerticalResolution);
// Create the final image with the proper background color.
using (Graphics g = Graphics.FromImage(croppedImage))
{
g.Clear(savePaperColor);
g.DrawImage(renderedImage, new Rectangle(0, 0, croppedImage.Width, croppedImage.Height), crop.X,
crop.Y, crop.Width, crop.Height, GraphicsUnit.Pixel);
croppedImage.Save(filePath);
}
}
}