TeX file processing options class. More...

Inherits System::Object.

Public Member Functions

ASPOSE_TEX_SHARED_API System::String get_JobName () const
 Gets/set the name of the job. More...
 
ASPOSE_TEX_SHARED_API void set_JobName (System::String value)
 Gets/set the name of the job. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< IO::IInputTerminalget_TerminalIn () const
 Gets/sets the input terminal reader. More...
 
ASPOSE_TEX_SHARED_API void set_TerminalIn (System::SharedPtr< IO::IInputTerminal > value)
 Gets/sets the input terminal reader. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< IO::IOutputTerminalget_TerminalOut () const
 Gets/sets the output terminal writer. More...
 
ASPOSE_TEX_SHARED_API void set_TerminalOut (System::SharedPtr< IO::IOutputTerminal > value)
 Gets/sets the output terminal writer. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< IO::IInputWorkingDirectoryget_InputWorkingDirectory () const
 Gets/sets input working directory. More...
 
ASPOSE_TEX_SHARED_API void set_InputWorkingDirectory (System::SharedPtr< IO::IInputWorkingDirectory > value)
 Gets/sets input working directory. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< IO::IOutputWorkingDirectoryget_OutputWorkingDirectory () const
 Gets/sets output working directory. More...
 
ASPOSE_TEX_SHARED_API void set_OutputWorkingDirectory (System::SharedPtr< IO::IOutputWorkingDirectory > value)
 Gets/sets output working directory. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< 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< 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 Aspose::TeX::Interaction get_Interaction () const
 Gets/sets the interaction mode to run a TeX engine in. More...
 
ASPOSE_TEX_SHARED_API void set_Interaction (Aspose::TeX::Interaction value)
 Gets/sets the interaction mode to run a TeX engine in. More...
 
ASPOSE_TEX_SHARED_API bool get_IgnoreMissingPackages () const
 Gets/sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it. More...
 
ASPOSE_TEX_SHARED_API void set_IgnoreMissingPackages (bool value)
 Gets/sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it. More...
 
ASPOSE_TEX_SHARED_API System::SharedPtr< Aspose::TeX::Presentation::SaveOptionsget_SaveOptions () const
 Gets/sets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS. More...
 
ASPOSE_TEX_SHARED_API void set_SaveOptions (System::SharedPtr< Aspose::TeX::Presentation::SaveOptions > value)
 Gets/sets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS. More...
 
ASPOSE_TEX_SHARED_API System::DateTime get_DateTime () const
 Gets/sets a certain value for date/time primitives like , , and . More...
 
ASPOSE_TEX_SHARED_API void set_DateTime (System::DateTime value)
 Gets/sets a certain value for date/time primitives like , , and . More...
 
ASPOSE_TEX_SHARED_API bool get_Repeat () const
 Gets/sets the flag that indicates whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data. More...
 
ASPOSE_TEX_SHARED_API void set_Repeat (bool value)
 Gets/sets the flag that indicates whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data. More...
 
ASPOSE_TEX_SHARED_API bool get_NoLigatures () const
 Gets/sets the flag that cancels ligatures in all fonts. More...
 
ASPOSE_TEX_SHARED_API void set_NoLigatures (bool value)
 Gets/sets the flag that cancels ligatures in all fonts. More...
 
ASPOSE_TEX_SHARED_API bool get_FullInputFileNames () const
 Gets/sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins. More...
 
ASPOSE_TEX_SHARED_API void set_FullInputFileNames (bool value)
 Gets/sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins. 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...
 

Static Public Member Functions

static ASPOSE_TEX_SHARED_API System::SharedPtr< TeXOptionsConsoleAppOptions (System::SharedPtr< TeXConfig > config)
 Returns options for use in a console application. 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...
 

Protected Member Functions

System::SharedPtr< TeXConfigget_Config () const
 Gets the TeX engine configuration. More...
 
Aspose::TeX::ShellMode get_ShellMode () const
 Determines the availability of . More...
 
void set_ShellMode (Aspose::TeX::ShellMode value)
 Determines the availability of . More...
 
bool get_IniTeX () const
 
void set_IniTeX (bool value)
 
System::SharedPtr< Logging::TeXLog > get_Log () const
 
void set_Log (System::SharedPtr< Logging::TeXLog > value)
 
System::SharedPtr< Reading::Object::IToApsConverter > get_ToApsConverter () const
 
void set_ToApsConverter (System::SharedPtr< Reading::Object::IToApsConverter > value)
 
bool get_ShowOutputGlueHandling () const
 
void set_ShowOutputGlueHandling (bool value)
 
 TeXOptions (System::SharedPtr< TeXConfig > config)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (TeXOptions, CODEPORTING_ARGS(System::SharedPtr< TeXConfig > config))
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

TeX file processing options class.

Constructor & Destructor Documentation

◆ TeXOptions()

Aspose::TeX::TeXOptions::TeXOptions ( System::SharedPtr< TeXConfig config)
protected

Member Function Documentation

◆ ConsoleAppOptions()

static ASPOSE_TEX_SHARED_API System::SharedPtr<TeXOptions> Aspose::TeX::TeXOptions::ConsoleAppOptions ( System::SharedPtr< TeXConfig config)
static

Returns options for use in a console application.

Parameters
configA TeX config.
Returns
TeX options.

◆ get_Config()

System::SharedPtr<TeXConfig> Aspose::TeX::TeXOptions::get_Config ( ) const
protected

Gets the TeX engine configuration.

◆ get_DateTime()

ASPOSE_TEX_SHARED_API System::DateTime Aspose::TeX::TeXOptions::get_DateTime ( ) const

Gets/sets a certain value for date/time primitives like , , and .

◆ get_FullInputFileNames()

ASPOSE_TEX_SHARED_API bool Aspose::TeX::TeXOptions::get_FullInputFileNames ( ) const

Gets/sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins.

◆ get_IgnoreMissingPackages()

ASPOSE_TEX_SHARED_API bool Aspose::TeX::TeXOptions::get_IgnoreMissingPackages ( ) const

Gets/sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it.

◆ get_IniTeX()

bool Aspose::TeX::TeXOptions::get_IniTeX ( ) const
protected

◆ get_InputWorkingDirectory()

ASPOSE_TEX_SHARED_API System::SharedPtr<IO::IInputWorkingDirectory> Aspose::TeX::TeXOptions::get_InputWorkingDirectory ( ) const

Gets/sets input working directory.

◆ get_Interaction()

ASPOSE_TEX_SHARED_API Aspose::TeX::Interaction Aspose::TeX::TeXOptions::get_Interaction ( ) const

Gets/sets the interaction mode to run a TeX engine in.

◆ get_JobName()

ASPOSE_TEX_SHARED_API System::String Aspose::TeX::TeXOptions::get_JobName ( ) const

Gets/set the name of the job.

◆ get_Log()

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

◆ get_NoLigatures()

ASPOSE_TEX_SHARED_API bool Aspose::TeX::TeXOptions::get_NoLigatures ( ) const

Gets/sets the flag that cancels ligatures in all fonts.

◆ get_OutputWorkingDirectory()

ASPOSE_TEX_SHARED_API System::SharedPtr<IO::IOutputWorkingDirectory> Aspose::TeX::TeXOptions::get_OutputWorkingDirectory ( ) const

Gets/sets output working directory.

◆ get_Repeat()

ASPOSE_TEX_SHARED_API bool Aspose::TeX::TeXOptions::get_Repeat ( ) const

Gets/sets the flag that indicates whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data.

◆ get_RequiredInputDirectory()

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

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

◆ get_SaveOptions()

ASPOSE_TEX_SHARED_API System::SharedPtr<Aspose::TeX::Presentation::SaveOptions> Aspose::TeX::TeXOptions::get_SaveOptions ( ) const

Gets/sets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS.

◆ get_ShellMode()

Aspose::TeX::ShellMode Aspose::TeX::TeXOptions::get_ShellMode ( ) const
protected

Determines the availability of .

◆ get_ShowOutputGlueHandling()

bool Aspose::TeX::TeXOptions::get_ShowOutputGlueHandling ( ) const
protected

◆ get_TerminalIn()

ASPOSE_TEX_SHARED_API System::SharedPtr<IO::IInputTerminal> Aspose::TeX::TeXOptions::get_TerminalIn ( ) const

Gets/sets the input terminal reader.

◆ get_TerminalOut()

ASPOSE_TEX_SHARED_API System::SharedPtr<IO::IOutputTerminal> Aspose::TeX::TeXOptions::get_TerminalOut ( ) const

Gets/sets the output terminal writer.

◆ get_ToApsConverter()

System::SharedPtr<Reading::Object::IToApsConverter> Aspose::TeX::TeXOptions::get_ToApsConverter ( ) const
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::TeX::TeXOptions::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( TeXOptions  ,
CODEPORTING_ARGS(System::SharedPtr< TeXConfig > config)   
)
protected

◆ set_DateTime()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_DateTime ( System::DateTime  value)

Gets/sets a certain value for date/time primitives like , , and .

◆ set_FullInputFileNames()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_FullInputFileNames ( bool  value)

Gets/sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins.

◆ set_IgnoreMissingPackages()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_IgnoreMissingPackages ( bool  value)

Gets/sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it.

◆ set_IniTeX()

void Aspose::TeX::TeXOptions::set_IniTeX ( bool  value)
protected

◆ set_InputWorkingDirectory()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_InputWorkingDirectory ( System::SharedPtr< IO::IInputWorkingDirectory value)

Gets/sets input working directory.

◆ set_Interaction()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_Interaction ( Aspose::TeX::Interaction  value)

Gets/sets the interaction mode to run a TeX engine in.

◆ set_JobName()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_JobName ( System::String  value)

Gets/set the name of the job.

◆ set_Log()

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

◆ set_NoLigatures()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_NoLigatures ( bool  value)

Gets/sets the flag that cancels ligatures in all fonts.

◆ set_OutputWorkingDirectory()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_OutputWorkingDirectory ( System::SharedPtr< IO::IOutputWorkingDirectory value)

Gets/sets output working directory.

◆ set_Repeat()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_Repeat ( bool  value)

Gets/sets the flag that indicates whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data.

◆ set_RequiredInputDirectory()

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

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

◆ set_SaveOptions()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_SaveOptions ( System::SharedPtr< Aspose::TeX::Presentation::SaveOptions value)

Gets/sets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS.

◆ set_ShellMode()

void Aspose::TeX::TeXOptions::set_ShellMode ( Aspose::TeX::ShellMode  value)
protected

Determines the availability of .

◆ set_ShowOutputGlueHandling()

void Aspose::TeX::TeXOptions::set_ShowOutputGlueHandling ( bool  value)
protected

◆ set_TerminalIn()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_TerminalIn ( System::SharedPtr< IO::IInputTerminal value)

Gets/sets the input terminal reader.

◆ set_TerminalOut()

ASPOSE_TEX_SHARED_API void Aspose::TeX::TeXOptions::set_TerminalOut ( System::SharedPtr< IO::IOutputTerminal value)

Gets/sets the output terminal writer.

◆ set_ToApsConverter()

void Aspose::TeX::TeXOptions::set_ToApsConverter ( System::SharedPtr< Reading::Object::IToApsConverter >  value)
protected