Microsoft.HtmlTrans.Interface

Specifies the browser type to target in converting a document to HTML.

Specifies the browser to target in converting a document to HTML is Internet Explorer 3.0 level browsers and earlier.

Specifies the browser to target in converting a document to HTML is Internet Explorer 4.0 level browsers and later.

Specifies the browser to target in converting a document to HTML is unknown.

Provides methods to access and manage file content and information in a document conversion.

Gets or sets the return code that the conversion framework will return.

A value that specifies the error type.

Gets or sets the error message that the converter might create.

A string that specifies the error message.

Gets a Boolean value that indicates whether the converter created an error string, i.e., whether the property value of is valid.

true if the converter created an error string; otherwise, false.

Gets a Boolean value that indicates whether the converter produced output.

true if the converter produced output; otherwise, false.

Gets a Boolean value that indicates whether the converter produced additional files on top of the main file (e.g., images in addition to an HTML file).

true if the converter produced additional files; otherwise, false.

Gets or sets the name of the main file.

A string that contains the name of the main file. Use the property to access the content of a file.

Gets or sets a Byte array that contains the main file that the converter produced.

A Byte array that contains the main file.

Gets or sets an array of Byte arrays that contain additional files that the converter might have produced (for example, images for an HTML file).

A Byte array that contains the additional files.

Gets or sets an array that contains the names of additional files that the converter might have produced.

A string array that contains the names of additional files.

Gets or sets the name of the folder where the additional files got created.

A string that contains the folder name.

Contains the results of the document conversion.

Initializes a new instance of the class.

Gets or sets a constant value that reports errors that may occur during the document conversion process.

A value.

Gets a value indicating whether the HTML results of the document conversion include a main HTML file.

true if the HTML results of the document conversion include a main HTML file; false if an error occurs and the converter fails to generate the expected HTML output.

Gets or sets a Boolean value that indicates whether the HTML results of the document conversion include supporting files in addition to the main HTML file.

true if the HTML results of the document conversion include supporting files; otherwise, false.

Gets or sets the binary contents of the main HTML file resulting from the document conversion.

A Byte (8-bit integer) array that contains the main HTML file.

Gets or sets the binary contents of the supporting files, if any, resulting from the document conversion

An array of Byte arrays that contains the supporting files.

Gets or sets the name of the additional supporting files, if any, generated by the document conversion.

A string that contains an array of the names of the additional supporting files, if any.

Gets or sets the name of the main HTML file generated by the document conversion.

A string that contains the name of the main output file.

Gets or sets the location of the main HTML file generated by the document conversion.

A string that contains the file path specified in URL format (for example, http://server_name/site_name/file_name ).

Gets or sets the location of the supporting files included as part of the results of the document conversion.

A string that contains the name of the subfolder under the parent folder specified in the strMainFilePath property.

Returns errors that may occur during the document conversion process.

Indicates no error has occurred.

Indicates the converter has crashed.

Indicates the converter has not responded within the time-out specified in the call to the method. Increasing the time-out value might prevent this error.

Indicates that the converter failed to produce any output.

Indicates the IHtmlTrLauncher implementation could not locate the converter.

Indicates there is insufficient memory or other resources to complete the conversion.

Indicates the handler page could not retrieve the requested file from Windows SharePoint Services.

Indicates a disk write error has occurred.

Indicates the command-line arguments used to start the converter are invalid; for example, the file type is not recognized by the custom converter application.

Indicates the objects implementing the IHtmlTrLoadBalancer or IHtmlTrLauncher interface are unavailable.

Indicates the specified conversion task is already running.

Indicates the converter did not begin its task before the specified time-out.

Indicates an unspecified error has occurred.

This class is reserved for internal use and is not intended to be used directly from your code.

This class is reserved for internal use and is not intended to be used directly from your code.

Exposes a single method that starts the process of converting a document to HTML format for viewing in the browser by a user who does not have the appropriate client application or viewer installed.

Starts the process of converting a document to HTML format for viewing in the browser by a user who does not have the appropriate client application or viewer installed.

Microsoft.HtmlTrans.CreateHtmlInfo The HTML output of the conversion process is returned in an instance of the CreateHtmlInfo class, which also contains information about any conversion error that occurred and about additional supporting files that may be part of the output. Specifies the server hosting the launcher application by using the value returned by the StrGetLauncher method of the IHtmlTrLoadBalancer interface. The binary contents of the source file. Specifies the target browser type by using a constant from the enumeration. The URL of the document to convert. The document conversion task name, which the load balancer uses to keep track of the request. The time in seconds before the document conversion times out. Specifies whether to return the binary contents of the converted file (that is, the HTML output) in the rgbMainFile and rgrgbThicketFiles properties of the instance of the CreateHtmlInfo class returned by the CHICreateHtml method.

Manages the load on multiple servers hosting document conversion launcher services.

Notifies the load balancer component that the server has completed the specified document conversion task.

Boolean Returns true for success, false for failure. The name of the server that has completed the document conversion task. The name of the document conversion task previously passed in the call to the method.

Notifies the load balancer component that a server hosting the launcher component is ready to begin handling document conversion requests.

Boolean Returns true for success; false for failure. A Uniform Resource Identifier (URI) that identifies the server hosting the launcher.

Returns the name of the server hosting a launcher component to use for the document conversion.

A string that contains a Uniform Resource Identifier (URI) that identifies the server hosting the launcher. Pass this value as the argument to the CHICreateHtml method. The name assigned to the document conversion task. Receives a value of TransformCurrentlyRunning if a task with the specified name is already running.

Notifies the load balancer component that a server hosting the launcher component is no longer handling document conversion requests.

A Boolean value. Returns true for success; false for failure. The name of the server hosting the launcher component.

Returns a status value to the handler page that requests a document conversion.

Indicates that the document conversion task with the specified name is already in progress.

Indicates that the component implementing the IHtmlTrLauncher interface is unavailable.

Indicates that the component implementing the IHtmlTrLoadBalancer interface is unavailable.

Indicates that the request to the custom conversion components from the handler page succeeded.