Aspose::Words::Rendering::NodeRendererBase Class Reference

Detailed Description

Base class for ShapeRenderer and OfficeMathRenderer.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

#include <Aspose.Words.Cpp/Rendering/NodeRendererBase.h>

Inheritance diagram for Aspose::Words::Rendering::NodeRendererBase:

Public Member Functions
	NodeRendererBase ()
RectangleF	get_BoundsInPoints () const
	Gets the actual bounds of the shape in points. More...
RectangleF	get_OpaqueBoundsInPoints ()
	Gets the opaque bounds of the shape in points. More...
SizeF	get_SizeInPoints ()
	Gets the actual size of the shape in points. More...
Rectangle	GetBoundsInPixels (float scale, float dpi)
	Calculates the bounds of the shape in pixels for a specified zoom factor and resolution. More...
Rectangle	GetBoundsInPixels (float scale, float horizontalDpi, float verticalDpi)
	Calculates the bounds of the shape in pixels for a specified zoom factor and resolution. More...
Rectangle	GetOpaqueBoundsInPixels (float scale, float dpi)
	Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution. More...
Rectangle	GetOpaqueBoundsInPixels (float scale, float horizontalDpi, float verticalDpi)
	Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution. More...
Size	GetSizeInPixels (float scale, float dpi)
	Calculates the size of the shape in pixels for a specified zoom factor and resolution. More...
Size	GetSizeInPixels (float scale, float horizontalDpi, float verticalDpi)
	Calculates the size of the shape in pixels for a specified zoom factor and resolution. More...
virtual const TypeInfo &	GetType () const override
virtual bool	Is (const TypeInfo &target) const override
SizeF	RenderToScale (const SharedPtr< Graphics > &graphics, float x, float y, float scale)
	Renders the shape into a Graphics object to a specified scale. More...
float	RenderToSize (const SharedPtr< Graphics > &graphics, float x, float y, float width, float height)
	Renders the shape into a Graphics object to a specified size. More...
void	Save (const SharedPtr< Stream > &stream, SharedPtr< ImageSaveOptions > saveOptions)
	Renders the shape into an image and saves into a stream. More...
void	Save (const String &fileName, SharedPtr< ImageSaveOptions > saveOptions)
	Renders the shape into an image and saves into a file. More...
template<typename CharType , typename Traits >
void	Save (std::basic_ostream< CharType, Traits > &stream, SharedPtr< ImageSaveOptions > saveOptions)

Static Public Member Functions
static const TypeInfo &	Type ()

Constructor & Destructor Documentation

NodeRendererBase()

Aspose::Words::Rendering::NodeRendererBase::NodeRendererBase

(

)

Member Function Documentation

get_BoundsInPoints()

System::Drawing::RectangleF Aspose::Words::Rendering::NodeRendererBase::get_BoundsInPoints

(

)

const

Gets the actual bounds of the shape in points.

This property returns the actual (as rendered on the page) bounding box of the shape. The bounds takes into account shape rotation (if any).

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

get_OpaqueBoundsInPoints()

System::Drawing::RectangleF Aspose::Words::Rendering::NodeRendererBase::get_OpaqueBoundsInPoints

(

)

Gets the opaque bounds of the shape in points.

This property returns the opaque (i.e. transparent parts of the shape are ignored) bounding box of the shape. The bounds takes the shape rotation into account.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

get_SizeInPoints()

System::Drawing::SizeF Aspose::Words::Rendering::NodeRendererBase::get_SizeInPoints

(

)

Gets the actual size of the shape in points.

This property returns the size of the actual (as rendered on the page) bounding box of the shape. The size takes into account shape rotation (if any).

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetBoundsInPixels() [1/2]

System::Drawing::Rectangle Aspose::Words::Rendering::NodeRendererBase::GetBoundsInPixels	(	float	scale,
		float	dpi
	)

Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts BoundsInPoints into rectangle in pixels.

Parameters

scale	The zoom factor (1.0 is 100%).
dpi	The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).

Returns

The actual (as rendered on the page) bounding box of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetBoundsInPixels() [2/2]

System::Drawing::Rectangle Aspose::Words::Rendering::NodeRendererBase::GetBoundsInPixels	(	float	scale,
		float	horizontalDpi,
		float	verticalDpi
	)

Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts BoundsInPoints into rectangle in pixels.

Parameters

scale	The zoom factor (1.0 is 100%).
horizontalDpi	The horizontal resolution to convert from points to pixels (dots per inch).
verticalDpi	The vertical resolution to convert from points to pixels (dots per inch).

Returns

The actual (as rendered on the page) bounding box of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetOpaqueBoundsInPixels() [1/2]

System::Drawing::Rectangle Aspose::Words::Rendering::NodeRendererBase::GetOpaqueBoundsInPixels	(	float	scale,
		float	dpi
	)

Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts OpaqueBoundsInPoints into rectangle in pixels and it is useful when you want to create a bitmap for rendering the shape with only opaque part of the shape.

Parameters

scale	The zoom factor (1.0 is 100%).
dpi	The resolution to convert from points to pixels (dots per inch).

Returns

The opaque rectangle of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetOpaqueBoundsInPixels() [2/2]

System::Drawing::Rectangle Aspose::Words::Rendering::NodeRendererBase::GetOpaqueBoundsInPixels	(	float	scale,
		float	horizontalDpi,
		float	verticalDpi
	)

Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts OpaqueBoundsInPoints into rectangle in pixels and it is useful when you want to create a bitmap for rendering the shape with only opaque part of the shape.

Parameters

scale	The zoom factor (1.0 is 100%).
horizontalDpi	The horizontal resolution to convert from points to pixels (dots per inch).
verticalDpi	The vertical resolution to convert from points to pixels (dots per inch).

Returns

The opaque rectangle of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetSizeInPixels() [1/2]

System::Drawing::Size Aspose::Words::Rendering::NodeRendererBase::GetSizeInPixels	(	float	scale,
		float	dpi
	)

Calculates the size of the shape in pixels for a specified zoom factor and resolution.

This method converts SizeInPoints into size in pixels and it is useful when you want to create a bitmap for rendering the shape neatly onto the bitmap.

Parameters

scale	The zoom factor (1.0 is 100%).
dpi	The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).

Returns

The size of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetSizeInPixels() [2/2]

System::Drawing::Size Aspose::Words::Rendering::NodeRendererBase::GetSizeInPixels	(	float	scale,
		float	horizontalDpi,
		float	verticalDpi
	)

Calculates the size of the shape in pixels for a specified zoom factor and resolution.

This method converts SizeInPoints into size in pixels and it is useful when you want to create a bitmap for rendering the shape neatly onto the bitmap.

Parameters

scale	The zoom factor (1.0 is 100%).
horizontalDpi	The horizontal resolution to convert from points to pixels (dots per inch).
verticalDpi	The vertical resolution to convert from points to pixels (dots per inch).

Returns

The size of the shape in pixels.

Examples

Shows how to measure and scale shapes.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto officeMath = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
auto renderer = MakeObject<OfficeMathRenderer>(officeMath);
 
// Verify the size of the image that the OfficeMath object will create when we render it.
ASSERT_NEAR(119.0f, renderer->get_SizeInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_SizeInPoints().get_Height(), 0.1f);
 
ASSERT_NEAR(119.0f, renderer->get_BoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(13.0f, renderer->get_BoundsInPoints().get_Height(), 0.1f);
 
// Shapes with transparent parts may contain different values in the "OpaqueBoundsInPoints" properties.
ASSERT_NEAR(119.0f, renderer->get_OpaqueBoundsInPoints().get_Width(), 0.2f);
ASSERT_NEAR(14.2f, renderer->get_OpaqueBoundsInPoints().get_Height(), 0.1f);
 
// Get the shape size in pixels, with linear scaling to a specific DPI.
System::Drawing::Rectangle bounds = renderer->GetBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
// Get the shape size in pixels, but with a different DPI for the horizontal and vertical dimensions.
bounds = renderer->GetBoundsInPixels(1.0f, 96.0f, 150.0f);
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(28, bounds.get_Height());
 
// The opaque bounds may vary here also.
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(18, bounds.get_Height());
 
bounds = renderer->GetOpaqueBoundsInPixels(1.0f, 96.0f, 150.0f);
 
ASSERT_EQ(159, bounds.get_Width());
ASSERT_EQ(30, bounds.get_Height());

GetType()

virtual const System::TypeInfo & Aspose::Words::Rendering::NodeRendererBase::GetType ( ) const

overridevirtual

Reimplemented from System::Object.

Reimplemented in Aspose::Words::Rendering::OfficeMathRenderer, and Aspose::Words::Rendering::ShapeRenderer.

Is()

virtual bool Aspose::Words::Rendering::NodeRendererBase::Is ( const System::TypeInfo &  target ) const

overridevirtual

Reimplemented from System::Object.

Reimplemented in Aspose::Words::Rendering::OfficeMathRenderer, and Aspose::Words::Rendering::ShapeRenderer.

RenderToScale()

System::Drawing::SizeF Aspose::Words::Rendering::NodeRendererBase::RenderToScale	(	const System::SharedPtr< System::Drawing::Graphics > &	graphics,
		float	x,
		float	y,
		float	scale
	)

Renders the shape into a Graphics object to a specified scale.

Parameters

graphics	The object where to render to.
x	The X coordinate (in world units) of the top left corner of the rendered shape.
y	The Y coordinate (in world units) of the top left corner of the rendered shape.
scale	The scale for rendering the shape (1.0 is 100%).

Returns

The width and height (in world units) of the rendered shape.

RenderToSize()

float Aspose::Words::Rendering::NodeRendererBase::RenderToSize	(	const System::SharedPtr< System::Drawing::Graphics > &	graphics,
		float	x,
		float	y,
		float	width,
		float	height
	)

Renders the shape into a Graphics object to a specified size.

Parameters

graphics	The object where to render to.
x	The X coordinate (in world units) of the top left corner of the rendered shape.
y	The Y coordinate (in world units) of the top left corner of the rendered shape.
width	The maximum width (in world units) that can be occupied by the rendered shape.
height	The maximum height (in world units) that can be occupied by the rendered shape.

Returns

The scale that was automatically calculated for the rendered shape to fit the specified size.

Save() [1/3]

void Aspose::Words::Rendering::NodeRendererBase::Save	(	const System::SharedPtr< System::IO::Stream > &	stream,
		System::SharedPtr< Aspose::Words::Saving::ImageSaveOptions >	saveOptions
	)

Renders the shape into an image and saves into a stream.

Parameters

stream	The stream where to save the image of the shape.
saveOptions	Specifies the options that control how the shape is rendered and saved. Can be null. If this is null, the image will be saved in the PNG format.

Examples

Shows how to use a shape renderer to export shapes to files in the local file system.

auto doc = MakeObject<Document>(MyDir + u"Various shapes.docx");
ArrayPtr<SharedPtr<Shape>> shapes = doc->GetChildNodes(NodeType::Shape, true)->LINQ_OfType<SharedPtr<Shape>>()->LINQ_ToArray();
 
ASSERT_EQ(7, shapes->get_Length());
 
// There are 7 shapes in the document, including one group shape with 2 child shapes.
// We will render every shape to an image file in the local file system
// while ignoring the group shapes since they have no appearance.
// This will produce 6 image files.
for (const auto& shape : System::IterateOver(doc->GetChildNodes(NodeType::Shape, true)->LINQ_OfType<SharedPtr<Shape>>()))
{
    SharedPtr<ShapeRenderer> renderer = shape->GetShapeRenderer();
    auto options = MakeObject<ImageSaveOptions>(SaveFormat::Png);
    renderer->Save(ArtifactsDir + String::Format(u"Shape.RenderAllShapes.{0}.png", shape->get_Name()), options);
}

Save() [2/3]

void Aspose::Words::Rendering::NodeRendererBase::Save	(	const System::String &	fileName,
		System::SharedPtr< Aspose::Words::Saving::ImageSaveOptions >	saveOptions
	)

Renders the shape into an image and saves into a file.

Parameters

fileName	The name for the image file. If a file with the specified name already exists, the existing file is overwritten.
saveOptions	Specifies the options that control how the shape is rendered and saved. Can be null.

Examples

Shows how to render an Office Math object into an image file in the local file system.

auto doc = MakeObject<Document>(MyDir + u"Office math.docx");
 
auto math = System::DynamicCast<OfficeMath>(doc->GetChild(NodeType::OfficeMath, 0, true));
 
// Create an "ImageSaveOptions" object to pass to the node renderer's "Save" method to modify
// how it renders the OfficeMath node into an image.
auto saveOptions = MakeObject<ImageSaveOptions>(SaveFormat::Png);
 
// Set the "Scale" property to 5 to render the object to five times its original size.
saveOptions->set_Scale(5.0f);
 
math->GetMathRenderer()->Save(ArtifactsDir + u"Shape.RenderOfficeMath.png", saveOptions);

Save() [3/3]

template<typename CharType , typename Traits >

void Aspose::Words::Rendering::NodeRendererBase::Save ( std::basic_ostream< CharType, Traits > &  stream, System::SharedPtr< Aspose::Words::Saving::ImageSaveOptions >  saveOptions  )

inline

Type()

static const System::TypeInfo & Aspose::Words::Rendering::NodeRendererBase::Type ( )

static