Aspose::TeX::Features::FigureRendererOptions Class Reference

Common options for rendering a LaTeX source code fragment. More...

Inherits System::Object.

Inherited by Aspose::TeX::Features::MathRendererOptions, Aspose::TeX::Features::PngFigureRendererOptions, Aspose::TeX::Features::SvgFigureRendererOptions, and Aspose::TeX::Plugins::FigureRendererPluginOptions.

Public Member Functions

ASPOSE_TEX_SHARED_API System::String get_Preamble () const
 Gets/sets LaTeX document preamble. More...
 
ASPOSE_TEX_SHARED_API void set_Preamble (System::String value)
 Gets/sets LaTeX document preamble. More...
 
ASPOSE_TEX_SHARED_API int32_t get_Scale () const
 Gets/set the scale. 1000 means 100%, 1200 means 120%, etc. More...
 
ASPOSE_TEX_SHARED_API void set_Scale (int32_t value)
 Gets/set the scale. 1000 means 100%, 1200 means 120%, etc. More...
 
ASPOSE_TEX_SHARED_API System::Drawing::Color get_BackgroundColor () const
 Gets/sets the background color. More...
 
ASPOSE_TEX_SHARED_API void set_BackgroundColor (System::Drawing::Color value)
 Gets/sets the background color. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< System::IO::Streamget_LogStream () const
 Gets/set the stream to write log output to. More...
 
ASPOSE_TEX_SHARED_API void set_LogStream (System::SharedPtr< System::IO::Stream > value)
 Gets/set the stream to write log output to. More...
 
ASPOSE_TEX_SHARED_API bool get_ShowTerminal () const
 The flag that controls terminal output. If
true

then terminal output is written to console. More...

 
ASPOSE_TEX_SHARED_API void set_ShowTerminal (bool value)
 The flag that controls terminal output. If
true

then terminal output is written to console. More...

 
ASPOSE_TEX_SHARED_API System::String get_ErrorReport () const
 Gets the error report. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< Aspose::TeX::IO::IInputWorkingDirectoryget_RequiredInputDirectory () const
 Gets/sets the directory for the required input, e.g., packages that are beyond Aspose.TeX's LaTeX support. More...
 
ASPOSE_TEX_SHARED_API void set_RequiredInputDirectory (System::SharedPtr< Aspose::TeX::IO::IInputWorkingDirectory > value)
 Gets/sets the directory for the required input, e.g., packages that are beyond Aspose.TeX's LaTeX support. More...
 
ASPOSE_TEX_SHARED_API float get_Margin () const
 Gets/sets the margin width. More...
 
ASPOSE_TEX_SHARED_API void set_Margin (float value)
 Gets/sets the margin width. More...
 
ASPOSE_TEX_SHARED_API FigureRendererOptions ()
 Creates a new instance. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

ASPOSE_TEX_SHARED_API void set_ErrorReport (System::String value)
 Gets the error report. More...
 
System::SharedPtr< Aspose::TeX::Logging::TeXLog > get_Log () const
 
void set_Log (System::SharedPtr< Aspose::TeX::Logging::TeXLog > value)
 
System::SharedPtr< Aspose::TeX::IO::IOutputWorkingDirectoryget_OutputDirectory () const
 
void set_OutputDirectory (System::SharedPtr< Aspose::TeX::IO::IOutputWorkingDirectory > value)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Common options for rendering a LaTeX source code fragment.

Constructor & Destructor Documentation

◆ FigureRendererOptions()

ASPOSE_TEX_SHARED_API Aspose::TeX::Features::FigureRendererOptions::FigureRendererOptions ( )

Creates a new instance.

Member Function Documentation

◆ get_BackgroundColor()

ASPOSE_TEX_SHARED_API System::Drawing::Color Aspose::TeX::Features::FigureRendererOptions::get_BackgroundColor ( ) const

Gets/sets the background color.

◆ get_ErrorReport()

ASPOSE_TEX_SHARED_API System::String Aspose::TeX::Features::FigureRendererOptions::get_ErrorReport ( ) const

Gets the error report.

◆ get_Log()

System::SharedPtr<Aspose::TeX::Logging::TeXLog> Aspose::TeX::Features::FigureRendererOptions::get_Log ( ) const
protected

◆ get_LogStream()

ASPOSE_TEX_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::TeX::Features::FigureRendererOptions::get_LogStream ( ) const

Gets/set the stream to write log output to.

◆ get_Margin()

ASPOSE_TEX_SHARED_API float Aspose::TeX::Features::FigureRendererOptions::get_Margin ( ) const

Gets/sets the margin width.

◆ get_OutputDirectory()

System::SharedPtr<Aspose::TeX::IO::IOutputWorkingDirectory> Aspose::TeX::Features::FigureRendererOptions::get_OutputDirectory ( ) const
protected

◆ get_Preamble()

ASPOSE_TEX_SHARED_API System::String Aspose::TeX::Features::FigureRendererOptions::get_Preamble ( ) const

Gets/sets LaTeX document preamble.

◆ get_RequiredInputDirectory()

ASPOSE_TEX_SHARED_API System::SharedPtr<Aspose::TeX::IO::IInputWorkingDirectory> Aspose::TeX::Features::FigureRendererOptions::get_RequiredInputDirectory ( ) const

Gets/sets the directory for the required input, e.g., packages that are beyond Aspose.TeX's LaTeX support.

◆ get_Scale()

ASPOSE_TEX_SHARED_API int32_t Aspose::TeX::Features::FigureRendererOptions::get_Scale ( ) const

Gets/set the scale. 1000 means 100%, 1200 means 120%, etc.

◆ get_ShowTerminal()

ASPOSE_TEX_SHARED_API bool Aspose::TeX::Features::FigureRendererOptions::get_ShowTerminal ( ) const

The flag that controls terminal output. If

true

then terminal output is written to console.

◆ set_BackgroundColor()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_BackgroundColor ( System::Drawing::Color  value)

Gets/sets the background color.

◆ set_ErrorReport()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_ErrorReport ( System::String  value)
protected

Gets the error report.

◆ set_Log()

void Aspose::TeX::Features::FigureRendererOptions::set_Log ( System::SharedPtr< Aspose::TeX::Logging::TeXLog >  value)
protected

◆ set_LogStream()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_LogStream ( System::SharedPtr< System::IO::Stream value)

Gets/set the stream to write log output to.

◆ set_Margin()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_Margin ( float  value)

Gets/sets the margin width.

◆ set_OutputDirectory()

void Aspose::TeX::Features::FigureRendererOptions::set_OutputDirectory ( System::SharedPtr< Aspose::TeX::IO::IOutputWorkingDirectory value)
protected

◆ set_Preamble()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_Preamble ( System::String  value)

Gets/sets LaTeX document preamble.

◆ set_RequiredInputDirectory()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_RequiredInputDirectory ( System::SharedPtr< Aspose::TeX::IO::IInputWorkingDirectory value)

Gets/sets the directory for the required input, e.g., packages that are beyond Aspose.TeX's LaTeX support.

◆ set_Scale()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_Scale ( int32_t  value)

Gets/set the scale. 1000 means 100%, 1200 means 120%, etc.

◆ set_ShowTerminal()

ASPOSE_TEX_SHARED_API void Aspose::TeX::Features::FigureRendererOptions::set_ShowTerminal ( bool  value)

The flag that controls terminal output. If

true

then terminal output is written to console.