SolidFramework.Plumbing.Document Class Reference

Represents wrapper other document More...

Inheritance diagram for SolidFramework.Plumbing.Document:

Public Member Functions
virtual void	Dispose ()
virtual SolidFramework.Interop.NativeError	Close ()
virtual void	Create ()
	Creates this empty instance.
void	Open ()
	Opens the document. This will throw an exception if the path has not already been specified in the constructor. More...
void	Open (string password)
	Opens the document. This will throw an exception if the path has not already been specified in the constructor. More...
void	Save ()
	Saves the document
void	Save (SolidFramework.Plumbing.OverwriteMode mode)
	Saves the document and sets overwrite mode More...
void	Save (SolidFramework.Plumbing.OverwriteMode mode, bool useOptimizer)
	Saves the the document to the specified path with using of optimization More...
void	SaveAs (string path)
	Saves the document to specified path More...
void	SaveAs (string path, SolidFramework.Plumbing.OverwriteMode mode)
	Saves to specified path More...
void	SaveAs (string path, SolidFramework.Plumbing.OverwriteMode mode, bool useOptimizer)
	Saves to specified path More...
void	SaveOptimized ()
	Saves and apply optimization
void	SaveOptimized (SolidFramework.Plumbing.OverwriteMode mode)
	Saves and apply optimization More...
void	SaveOptimizedAs (string path)
	Saves to specified path and apply optimization More...
void	SaveOptimizedAs (string path, SolidFramework.Plumbing.OverwriteMode mode)
	Saves to specified path and apply optimization More...
bool	Equals (SolidFramework.Plumbing.Document other)
override bool	Equals (object obj)
override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.Plumbing.Document obj1, SolidFramework.Plumbing.Document obj2)
static bool	operator!= (SolidFramework.Plumbing.Document obj1, SolidFramework.Plumbing.Document obj2)

Properties
virtual SolidFramework.Plumbing.ICatalog	Catalog [get]
	Gets the catalog.
virtual string	Extension [get]
	Gets the extension.
string	Path [getset]
	Gets the path. More...
bool	IsLoaded [get]
	Gets a value indicating whether this document is loaded. More...
bool	RequiresOptimization [getset]
SolidFramework.Plumbing.OverwriteMode	OverwriteMode [getset]
	Gets the overwrite mode. More...
bool	Dirty [getset]
	Gets a value indicating whether this Document is dirty. More...

Detailed Description

Represents wrapper other document

Member Function Documentation

Open() [1/2]

void SolidFramework.Plumbing.Document.Open

(

)

Opens the document. This will throw an exception if the path has not already been specified in the constructor.

Exceptions

System.InvalidOperationException

with a message of "Path must be set before calling Open" occurs if the path has not been specified or is null.

Open() [2/2]

void SolidFramework.Plumbing.Document.Open

(

string

password

)

Opens the document. This will throw an exception if the path has not already been specified in the constructor.

Parameters

password

The password to be used when opening the file.

Exceptions

System.InvalidOperationException

with a message of "Path must be set before calling Open" occurs if the path has not been specified or is null.

Save() [1/2]

void SolidFramework.Plumbing.Document.Save

(

SolidFramework.Plumbing.OverwriteMode

mode

)

Saves the document and sets overwrite mode

Parameters

mode

The mode.

Save() [2/2]

void SolidFramework.Plumbing.Document.Save	(	SolidFramework.Plumbing.OverwriteMode	mode,
		bool	useOptimizer
	)

Saves the the document to the specified path with using of optimization

Parameters

mode	The mode.
useOptimizer	if set to true [use optimizer].

SaveAs() [1/3]

void SolidFramework.Plumbing.Document.SaveAs

(

string

path

)

Saves the document to specified path

Parameters

path

The path.

SaveAs() [2/3]

void SolidFramework.Plumbing.Document.SaveAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode
	)

Saves to specified path

Parameters

path	The path.
mode	The overwrite mode.

SaveAs() [3/3]

void SolidFramework.Plumbing.Document.SaveAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode,
		bool	useOptimizer
	)

Saves to specified path

Parameters

path	The path.
mode	The overwrite mode.
useOptimizer	if set to true [use optimizer].

SaveOptimized()

void SolidFramework.Plumbing.Document.SaveOptimized

(

SolidFramework.Plumbing.OverwriteMode

mode

)

Saves and apply optimization

Parameters

mode

The mode.

SaveOptimizedAs() [1/2]

void SolidFramework.Plumbing.Document.SaveOptimizedAs

(

string

path

)

Saves to specified path and apply optimization

Parameters

path

The path.

SaveOptimizedAs() [2/2]

void SolidFramework.Plumbing.Document.SaveOptimizedAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode
	)

Saves to specified path and apply optimization

Parameters

path	The path.
mode	The overwrite mode.

Property Documentation

Dirty

bool SolidFramework.Plumbing.Document.Dirty

getset

Gets a value indicating whether this Document is dirty.

true if dirty; otherwise, false.

IsLoaded

bool SolidFramework.Plumbing.Document.IsLoaded

get

Gets a value indicating whether this document is loaded.

true if this document is loaded; otherwise, false.

OverwriteMode

SolidFramework.Plumbing.OverwriteMode SolidFramework.Plumbing.Document.OverwriteMode

getset

Gets the overwrite mode.

The overwrite mode.

Path

string SolidFramework.Plumbing.Document.Path

getset

Gets the path.

The path.