Class TExternalNCFile

The external file is a file that was formed or obtained by a postprocessor in some special way, for example, through an external third-party program, and added to the list of postprocessor output files already in the finished form.

It is just a wrapper that allows to have properties of TNCFile class for some third-party files and hold them inside the common list of output files in TNCFilesManager.

Inheritance

object

TNCFile

TExternalNCFile

Inherited Members

TNCFile.OnInit()

TNCFile.SaveToFile(string)

TNCFile.Flush()

TNCFile.Manager

TNCFile.Owner

Namespace: DotnetPostprocessing.SDK

Assembly: DotnetPostprocessing.SDK.dll

Syntax

public class TExternalNCFile : TNCFile

Constructors

TExternalNCFile(INCFileOwner, string, bool, string)

Initializes a new instance of TExternalNCFile with the specified set of parameters.

Declaration

public TExternalNCFile(INCFileOwner Owner, string outputFileName, bool isBinary, string binaryFileDescription)

Parameters

Type	Name	Description
INCFileOwner	Owner	The object that is the owner of the output file formed by the postprocessor. Usually the owner is a postprocessor itself.
string	outputFileName	An external file path.
bool	isBinary	A property which determines whether the text or binary the file type is for the purpose of correctly displaying its contents to the user.
string	binaryFileDescription	Short textual description of the file content that will be shown to the user instead of hexadecimal representation (for binary files). If it is empty then hexadecimal representation of the file's bytes will be shown.

TExternalNCFile(INCFileOwner, string)

Initializes a new instance of TExternalNCFile with the specified file name, specifed owner object as an Owner of the file and IsBinary property equals to false.

Declaration

public TExternalNCFile(INCFileOwner Owner, string outputFileName)

Parameters

Type	Name	Description
INCFileOwner	Owner	The object that is the owner of the output file formed by the postprocessor. Usually the owner is a postprocessor itself.
string	outputFileName	An external file path.

TExternalNCFile(string)

Initializes a new instance of TExternalNCFile with the specified file name, current postprocessor as an Owner of the file and IsBinary property equals to false.

Declaration

public TExternalNCFile(string outputFileName)

Parameters

Type	Name	Description
string	outputFileName	An external file path.

Properties

IsBinary

A property which determines whether the text or binary the file type is for the purpose of correctly displaying its contents to the user. For binary files hexadecimal representation of the file's bytes will be shown by default.

Declaration

public bool IsBinary { get; }

Property Value

Type	Description
bool

OutputFileName

The file name with a full path where this output file should be placed at the finish.

Declaration

public override string OutputFileName { get; set; }

Property Value

Type	Description
string

Overrides

TNCFile.OutputFileName