Document Ultimate

https://docs.gleamtech.com/documentultimate/
Admin
Document Ultimate is an ASP.NET document viewer and .NET document converter supporting multiple...
Tokens:220,648
Snippets:1,647
Trust Score:9.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize DocumentViewerPrintOptions

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerPrintOptions__ctor.htm

Use this constructor to create a new instance of DocumentViewerPrintOptions. No specific setup or constraints are mentioned.

```csharp
public DocumentViewerPrintOptions()
```

```vb
Public Sub New
```

--------------------------------

### Get DocumentFormat Value (VB)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_DocumentFormatInfo_Value.htm

This property retrieves the DocumentFormat enumeration value. It is read-only and does not require any specific setup.

```vbnet
Public ReadOnly Property Value As DocumentFormat
	Get
End Property
```

--------------------------------

### Configure FileSystemFileProvider in VB.NET

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_ConvertTo_3.htm

Examples for setting up file providers using instances or provider strings, including specific user credentials and authentication modes.

```vbnet
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New PhysicalLocation() With {
        .Path = "c:\SomeFolder"
    }
}
```

```vbnet
fileProvider = "Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'"
```

```vbnet
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New PhysicalLocation() With {
        .Path = "\\server\share", 'Path can be a UNC path or a local path
        .UserName = "USERNAME",
        .Password = "PASSWORD"
    }
}
```

```vbnet
fileProvider = "Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'"
```

```vbnet
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New PhysicalLocation() With {
        .Path = "\\server\share", 'Path can be a UNC path or a local path
        .AuthenticatedUser = AuthenticatedUser.WebServer
    }
}
```

```vbnet
fileProvider = "Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; Authenticated User=WebServer'"
```

--------------------------------

### Configure Output Resolution

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_ImageOutputOptions.htm

Example showing how to set the output resolution to 120 DPI during document conversion.

```C#
var outputOptions = new ImageOutputOptions(DocumentFormat.Jpg)
{
    Resolution = 120
};

DocumentConverter.Convert(@"c:\SomeFolder\InputFile.pdf", outputOptions);
```

```VB
Dim outputOptions As New ImageOutputOptions(DocumentFormat.Jpg) With {
    .Resolution = 120
}

DocumentConverter.Convert("c:\SomeFolder\InputFile.pdf", outputOptions)
```

--------------------------------

### Enumerate Possible Formats Usage

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_EnumeratePossibleInputFormats.htm

Examples demonstrating how to enumerate possible input and output formats using both format types and file paths.

```C#
foreach (var outputFormat in DocumentConverter.EnumeratePossibleOutputFormats(DocumentFormat.Docx))
{
    // ...
}

foreach (var outputFormat in DocumentConverter.EnumeratePossibleOutputFormats("InputFile.docx"))
{
    // ...
}

//---------------------------------------

foreach (var inputFormat in DocumentConverter.EnumeratePossibleInputFormats(DocumentFormat.Pdf))
{
    // ...
}

foreach (var inputFormat in DocumentConverter.EnumeratePossibleInputFormats("OutputFile.pdf"))
{
    // ...
}
```

```VB
For Each outputFormat As Object In DocumentConverter.EnumeratePossibleOutputFormats(DocumentFormat.Docx)
    ' ...
Next

For Each outputFormat As Object In DocumentConverter.EnumeratePossibleOutputFormats("InputFile.docx")
    ' ...
Next

'---------------------------------------

For Each inputFormat As Object In DocumentConverter.EnumeratePossibleInputFormats(DocumentFormat.Pdf)
    ' ...
Next

For Each inputFormat As Object In DocumentConverter.EnumeratePossibleInputFormats("OutputFile.pdf")
    ' ...
Next
```

--------------------------------

### Get DocumentFormat Value (C#)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_DocumentFormatInfo_Value.htm

Use this property to retrieve the DocumentFormat enumeration value associated with a DocumentFormatInfo object. No setup is required beyond having an instance of DocumentFormatInfo.

```csharp
public DocumentFormat Value { get; }
```

--------------------------------

### Get Document Cache - VB

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_AspNet_DocumentUltimateWebConfiguration_GetCache.htm

Use this method to retrieve the DocumentCache instance associated with the web configuration. No specific setup is required beyond having an instance of DocumentUltimateWebConfiguration.

```vbnet
Public Function GetCache As DocumentCache
```

--------------------------------

### Configure DocumentUltimate in Startup.cs

Source: https://docs.gleamtech.com/documentultimate/html/using-documentultimate-in-an-asp-net-core-project.htm

Register services and the HTTP request pipeline in the traditional ASP.NET Core Startup class.

```csharp
public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }


    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllersWithViews();


        //----------------------
        //Add GleamTech to the ASP.NET Core services container.
        services.AddGleamTech();
        //----------------------
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }


        //----------------------
        //Register GleamTech to the ASP.NET Core HTTP request pipeline.
        app.UseGleamTech();
        //----------------------


        app.UseStaticFiles();

        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
        });
    }
```

--------------------------------

### Get Document Cache - C#

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_AspNet_DocumentUltimateWebConfiguration_GetCache.htm

Use this method to retrieve the DocumentCache instance associated with the web configuration. No specific setup is required beyond having an instance of DocumentUltimateWebConfiguration.

```csharp
public DocumentCache GetCache()
```

--------------------------------

### Initialize DocumentUltimateWebConfiguration (C#)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_AspNet_DocumentUltimateWebConfiguration__ctor.htm

Use this constructor to create a new instance of the DocumentUltimateWebConfiguration class. No specific setup or imports are required beyond the class definition.

```csharp
public DocumentUltimateWebConfiguration()
```

--------------------------------

### Create FileSystemFileProvider with credentials for UNC/protected paths

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter__ctor.htm

Set up a FileSystemFileProvider to connect to UNC or protected local paths using specific user credentials. The UserName can be in various formats like 'Domain\User' or UPN. Provider strings require quoting for values with semicolons.

```csharp
//---------------------------------------

//Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
//to connect as a specific Windows user to a UNC path or a protected local path:
//UserName can be specified as "Domain\User", "User@Domain" (UPN format), "Machine\User", "User" (local user).
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};

//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'";

//---------------------------------------
```

--------------------------------

### SpreadsheetInputOptions.RenderTitleColumns Property

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_SpreadsheetInputOptions_RenderTitleColumns.htm

Gets or sets the columns that contain the cells to be repeated on the left side of each page. For example "$A:$A" specifies first column only and "$A:$C" specifies first, second and third columns.

```APIDOC
## SpreadsheetInputOptions.RenderTitleColumns Property

### Description
Gets or sets the columns that contain the cells to be repeated on the left side of each page. For example "$A:$A" specifies first column only and "$A:$C" specifies first, second and third columns.

### Property Value
String

### See Also
- SpreadsheetInputOptions Class
- GleamTech.DocumentUltimate Namespace
```

--------------------------------

### Initialize FileSystemFileProvider

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_ConvertTo_3.htm

Configures access to physical file systems or UNC paths, optionally using specific user credentials.

```C#
FileProvider fileProvider;

//Setting a physical file provider via a FileSystemFileProvider instance:
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        //Path can also be virtual path string like "~/SomeFolder" in a web application.
        Path = @"c:\SomeFolder"
    }
};

//Setting a physical file provider via a provider string (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'";

//---------------------------------------

//Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
//to connect as a specific Windows user to a UNC path or a protected local path:
//UserName can be specified as "Domain\User", "User@Domain" (UPN format), "Machine\User", "User" (local user).
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};

//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'";

//---------------------------------------
```

--------------------------------

### CadInputOptions.RenderForegroundColor Property

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_CadInputOptions_RenderForegroundColor.htm

Gets or sets the foreground color of the drawing when it's rendered. The default is null, which means foreground colors will be kept same as in the drawing. When set, all foreground colors will be fixed to this same color. For example, you can have a black and white or a blueprint output.

```APIDOC
## CadInputOptions.RenderForegroundColor Property

### Description
Gets or sets the foreground color of the drawing when it's rendered. The default is null, which means foreground colors will be kept same as in the drawing. When set, all foreground colors will be fixed to this same color. For example, you can have a black and white or a blueprint output.

### Property Value
Nullable<Color>

### Notes to Callers
A GleamTech.Drawing.Color parameter/property can be implicitly (automatically) cast from/to other image libraries: 
  * System.Drawing.Color
  * SixLabors.ImageSharp.Color, SixLabors.ImageSharp.PixelFormats
  * SkiaSharp.SKColor
  * Microsoft.Maui.Graphics.Color

### See Also
- CadInputOptions Class
- GleamTech.DocumentUltimate Namespace
```

--------------------------------

### DocumentUltimateWebConfiguration.DocumentViewerHandlerPath Property

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_DocumentUltimateWebConfiguration_DocumentViewerHandlerPath.htm

Gets or sets a value that specifies the application-relative handler path for DocumentViewerHandler. The default is "documentviewer.ashx". It is not recommended to change it unless you have a conflict in your web application. This property will be effective only if it is changed before web application starts.

```APIDOC
## DocumentUltimateWebConfiguration.DocumentViewerHandlerPath Property

### Description
Gets or sets a value that specifies the application-relative handler path for DocumentViewerHandler. The default is "documentviewer.ashx". It is not recommended to change it unless you have a conflict in your web application. This property will be effective only if it is changed before web application starts.

### Property Value
String

### See Also
- Reference: DocumentUltimateWebConfiguration Class
- Reference: GleamTech.DocumentUltimate.AspNet Namespace
```

--------------------------------

### Configure DatabaseFileProvider with Instance (C#)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_Convert_2.htm

Instantiate DatabaseFileProvider in C#, setting mandatory and optional fields for database file system access. Ensure correct connection string and table/field names.

```csharp
FileProvider fileProvider;

//Setting a DatabaseFileProvider instance,
'to connect to a database file system.
'Mandatory fields are KeyField and ContentField.
'Optional fields DateModifiedField and SizeField: used for detailed file info, e.g. for generating better cache keys.
fileProvider = new DatabaseFileProvider() With {
    .File = "SomeFile.ext", 'File can also be set as a relative path "SomeFolder/SomeFile.ext".
    .ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    .ProviderName = "System.Data.SqlClient", 'ProviderName default value is "System.Data.SqlClient"
    .Table = "SomeTable", 'Table default value is "File".
    .KeyField = "Path", 'KeyField default value is "Id".
    .ContentField = "Content", 'ContentField default value is "Content".
    .NameField = "Name", 'NameField used for overriding file name specified in File (optional).
    .DateModifiedField = "DateModified", 'Provide DateModifiedField to prevent cache key conflicts.
    .SizeField = "Size" 'Provide SizeField to prevent cache key conflicts.
};
```

--------------------------------

### SpreadsheetInputOptions.RenderColumnsFitToPages Property

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_SpreadsheetInputOptions_RenderColumnsFitToPages.htm

Gets or sets the number of pages the columns should fit when it's rendered. The default is 0 which means columns could be broken into multiple pages if required. For example if you set the value 1, all columns would be rendered on a single page.

```APIDOC
## SpreadsheetInputOptions.RenderColumnsFitToPages Property

### Description
Gets or sets the number of pages the columns should fit when it's rendered. The default is 0 which means columns could be broken into multiple pages if required. For example if you set the value 1, all columns would be rendered on a single page.

### Property Value
Int32

### See Also
- SpreadsheetInputOptions Class
- GleamTech.DocumentUltimate Namespace
```

--------------------------------

### Initialize FileSystemFileProvider

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_WebForms_DocumentViewerControl_Document.htm

Configures physical file system access using PhysicalLocation or provider strings, including support for specific user credentials and web server impersonation.

```csharp
FileProvider fileProvider;

//Setting a physical file provider via a FileSystemFileProvider instance:
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        //Path can also be virtual path string like "~/SomeFolder" in a web application.
        Path = @"c:\SomeFolder"
    }
};

//Setting a physical file provider via a provider string (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'";

//---------------------------------------

//Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
//to connect as a specific Windows user to a UNC path or a protected local path:
//UserName can be specified as "Domain\User", "User@Domain" (UPN format), "Machine\User", "User" (local user).
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};

//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'";

//---------------------------------------

//Setting a physical file provider via a PhysicalLocation instance, to connect as the Web Server authenticated identity:
//For example, when you disable `Anonymous Authentication` and
//enable one of these authentication types for a web app in IIS:
//- `Windows Authentication (NTLM)`
//- `Digest Authentication (Negotiate)`
//- `Basic Authentication`
//Then IIS can pass the already authenticated user info to the web app.
//This user can then be impersonated by the web app when necessary, e.g. when accessing files.
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        AuthenticatedUser = AuthenticatedUser.WebServer
    }
};

//Setting a physical file provider via a provider string, to connect as the Web Server authenticated identity:
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; Authenticated User=WebServer'";
```

--------------------------------

### Configure Physical File System Access in C#

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Examples for connecting to local and network paths using FileSystemFileProvider with various authentication strategies.

```csharp
FileProvider fileProvider;

//Setting a physical file provider via a FileSystemFileProvider instance:
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        //Path can also be virtual path string like "~/SomeFolder" in a web application.
        Path = @"c:\SomeFolder"
    }
};

//Setting a physical file provider via a provider string (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'";

//---------------------------------------

//Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
//to connect as a specific Windows user to a UNC path or a protected local path:
//UserName can be specified as "Domain\User", "User@Domain" (UPN format), "Machine\User", "User" (local user).
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};

//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'";

//---------------------------------------

//Setting a physical file provider via a PhysicalLocation instance, to connect as the Web Server authenticated identity:
//For example, when you disable `Anonymous Authentication` and
//enable one of these authentication types for a web app in IIS:
//- `Windows Authentication (NTLM)`
//- `Digest Authentication (Negotiate)`
//- `Basic Authentication`
//Then IIS can pass the already authenticated user info to the web app.
//This user can then be impersonated by the web app when necessary, e.g. when accessing files.
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        AuthenticatedUser = AuthenticatedUser.WebServer
    }
};

//Setting a physical file provider via a provider string, to connect as the Web Server authenticated identity:
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; Authenticated User=WebServer'";

//---------------------------------------

//Setting a physical file provider via a PhysicalLocation instance, to connect as the Claims UPN identity:
//App's identities in `Thread.CurrentPrincipal` will be searched for a UPN (User Principal Name) claim.
//If any UPN is found, it will be authenticated via S4U Kerberos.
//This user can then be impersonated by the web app when necessary, e.g. when accessing files.
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        AuthenticatedUser = AuthenticatedUser.ClaimsUpn
    }
};

//Setting a physical file provider via a provider string, to connect as the Claims UPN identity:
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; Authenticated User=ClaimsUpn'";
```

--------------------------------

### WordProcessingInputOptions.UpdateFields Property

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_WordProcessingInputOptions_UpdateFields.htm

Gets or sets a value indicating if fields should be updated before the document is rendered/converted. The default is true. When set to true, it will mimic default "Save as PDF" or "Print" behaviour in Microsoft Word. For example, if you see "Error! Reference Source Not Found" messages instead of clickable links in the rendered document, you can set this to false (until you actually fix reference errors in your document).

```APIDOC
## WordProcessingInputOptions.UpdateFields Property

### Description
Gets or sets a value indicating if fields should be updated before the document is rendered/converted. The default is true. When set to true, it will mimic default "Save as PDF" or "Print" behaviour in Microsoft Word. For example, if you see "Error! Reference Source Not Found" messages instead of clickable links in the rendered document, you can set this to false (until you actually fix reference errors in your document).

### Property Type
Boolean

### C# Example
```csharp
public bool UpdateFields { get; set; }
```

### VB Example
```vb
Public Property UpdateFields As Boolean
	Get
	Set
End Property
```

### See Also
- [WordProcessingInputOptions Class](WordProcessingInputOptions.md)
- [GleamTech.DocumentUltimate Namespace](GleamTech.DocumentUltimate.md)
```

--------------------------------

### Configure Physical File System Access in VB.NET

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Examples for connecting to local paths using FileSystemFileProvider in VB.NET.

```vbnet
Dim fileProvider As FileProvider

'Setting a physical file provider via a FileSystemFileProvider instance:
'Path can also be virtual path string like "~/SomeFolder" in a web application.
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New PhysicalLocation() With {
        .Path = "c:\SomeFolder"
    }
}

'Setting a physical file provider via a provider string (same as above):
'In a provider string, if a value contains semi-colon character, that value should be enclosed
'in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = "Type=FileSystem; File=SomeFile.ext; Location='Type=Physical; Path=c:\SomeFolder'"

'---------------------------------------

'Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
'to connect as a specific Windows user to a UNC path or a protected local path:
```

--------------------------------

### Install DocumentUltimate from custom NuGet feed

Source: https://docs.gleamtech.com/documentultimate/html/adding-references-to-documentultimate-assemblies.htm

Use this command to install the DocumentUltimate package from the GleamTech NuGet feed.

```powershell
Install-Package GleamTech.DocumentUltimate -Source https://get.gleamtech.com/nuget/default/
```

--------------------------------

### Install DocumentUltimate via NuGet Package Manager Console

Source: https://docs.gleamtech.com/documentultimate/html/adding-references-to-documentultimate-assemblies.htm

Use this command to install the DocumentUltimate package from the official nuget.org feed.

```powershell
Install-Package GleamTech.DocumentUltimate
```

--------------------------------

### Configure DatabaseFileProvider with Instance (VB.NET)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_Convert_3.htm

Instantiate DatabaseFileProvider in VB.NET, setting mandatory fields like File and ConnectionString, and optional fields for detailed file information. Ensure values with semicolons are quoted.

```vbnet
Dim fileProvider As FileProvider

'Setting a DatabaseFileProvider instance,
'to connect to a database file system.
'Mandatory fields are KeyField and ContentField.
'Optional fields DateModifiedField and SizeField: used for detailed file info, e.g. for generating better cache keys.
fileProvider = New DatabaseFileProvider() With {
    .File = "SomeFile.ext", 'File can also be set as a relative path "SomeFolder/SomeFile.ext".
    .ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    .ProviderName = "System.Data.SqlClient", 'ProviderName default value is "System.Data.SqlClient" 
    .Table = "SomeTable", 'Table default value is "File".
    .KeyField = "Path", 'KeyField default value is "Id".
    .ContentField = "Content", 'ContentField default value is "Content".
    .NameField = "Name", 'NameField used for overriding file name specified in File (optional).
    .DateModifiedField = "DateModified", 'Provide DateModifiedField to prevent cache key conflicts.
    .SizeField = "Size" 'Provide SizeField to prevent cache key conflicts.
}
```

--------------------------------

### Configure DatabaseFileProvider with Instance (C#)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_Convert_3.htm

Instantiate DatabaseFileProvider in C#, setting mandatory fields like File and ConnectionString, and optional fields for detailed file information. Ensure values with semicolons are quoted.

```csharp
FileProvider fileProvider;

//Setting a DatabaseFileProvider instance,
//to connect to a database file system.
//Mandatory fields are KeyField and ContentField.
//Optional fields DateModifiedField and SizeField: used for detailed file info, e.g. for generating better cache keys.
fileProvider = new DatabaseFileProvider() {
    File = "SomeFile.ext", //File can also be set as a relative path "SomeFolder/SomeFile.ext".
    ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    ProviderName = "System.Data.SqlClient", //ProviderName default value is "System.Data.SqlClient"
    Table = "SomeTable", //Table default value is "File".
    KeyField = "Path", //KeyField default value is "Id".
    ContentField = "Content", //ContentField default value is "Content".
    NameField = "Name", //NameField used for overriding file name specified in File (optional).
    DateModifiedField = "DateModified", //Provide DateModifiedField to prevent cache key conflicts.
    SizeField = "Size" //Provide SizeField to prevent cache key conflicts.
};
```

--------------------------------

### Get or Set Grayscale Property (VB)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerPrintOptions_Grayscale.htm

This VB code shows how to get or set the Grayscale property. Note that this API is obsolete and no longer useful.

```vb
<ObsoleteAttribute("Grayscale is deprecated, as it's no longer useful.")>
Public Property Grayscale As Boolean
	Get
	Set
```

--------------------------------

### Create FileSystemFileProvider via provider string with credentials

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter__ctor_1.htm

Configure a FileSystemFileProvider using a provider string to connect as a specific user to a UNC path. Values with semi-colons require quoting. This example includes path, username, and password.

```csharp
//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'";
```

--------------------------------

### Get or Set Grayscale Property (C#)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerPrintOptions_Grayscale.htm

This C# code shows how to get or set the Grayscale property. Note that this API is obsolete and no longer useful.

```csharp
[ObsoleteAttribute("Grayscale is deprecated, as it's no longer useful.")]
public bool Grayscale { get; set; }
```

--------------------------------

### Converting to an Output Stream

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_ConvertTo_4.htm

Example demonstrating how to initialize a DocumentConverter and convert a file to PDF format using an output stream.

```C#
var documentConverter = new DocumentConverter(@"c:\SomeFolder\InputFile.docx");

// Convert "InputFile.docx" to Pdf written to outputStream
using (outputStream)
    documentConverter.ConvertTo(outputStream, DocumentFormat.Pdf);
```

```VB
Dim documentConverter As New DocumentConverter("c:\SomeFolder\InputFile.docx")

' Convert "InputFile.docx" to Pdf written to outputStream
Using outputStream
    documentConverter.ConvertTo(outputStream, DocumentFormat.Pdf)
End Using
```

--------------------------------

### Get DocumentViewerPermissions DeniedPermissions - VB.NET

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_WebForms_DocumentViewerControl_DeniedPermissions.htm

Gets or sets a value that specifies the denied permissions for the document viewer. The default is None. DeniedPermissions take precedence over AllowedPermissions.

```vbnet
Public Property DeniedPermissions As DocumentViewerPermissions
	Get
	Set
```

--------------------------------

### Get DocumentViewerPermissions DeniedPermissions - C#

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_WebForms_DocumentViewerControl_DeniedPermissions.htm

Gets or sets a value that specifies the denied permissions for the document viewer. The default is None. DeniedPermissions take precedence over AllowedPermissions.

```csharp
public DocumentViewerPermissions DeniedPermissions { get; set; }
```

--------------------------------

### Configure DatabaseFileProvider

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_Caching_DocumentCache_CreateCacheInfo.htm

Configures a database-backed file system provider. Requires KeyField and ContentField to be defined.

```C#
DateModifiedField = "DateModified", //Provide DateModifiedField to prevent cache key conflicts.
    SizeField = "Size" //Provide SizeField to prevent cache key conflicts.
};

//Setting a database file provider via a provider string (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = "Type=Database; File=SomeFolder/SomeFile.ext; Connection String='Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI'; Table=SomeTable; Key Field=Path; Content Field=Content";
```

```VB
Dim fileProvider As FileProvider

'Setting a DatabaseFileProvider instance,
'to connect to a database file system.
'Mandatory fields are KeyField and ContentField.
'Optional fields DateModifiedField and SizeField: used for detailed file info, e.g. for generating better cache keys.
fileProvider = New DatabaseFileProvider() With {
    .File = "SomeFile.ext", 'File can also be set as a relative path "SomeFolder/SomeFile.ext".
    .ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    .ProviderName = "System.Data.SqlClient", 'ProviderName default value is "System.Data.SqlClient"
    .Table = "SomeTable", 'Table default value is "File".
    .KeyField = "Path", 'KeyField default value is "Id".
    .ContentField = "Content", 'ContentField default value is "Content".
    .NameField = "Name", 'NameField used for overriding file name specified in File (optional).
    .DateModifiedField = "DateModified", 'Provide DateModifiedField to prevent cache key conflicts.
    .SizeField = "Size" 'Provide SizeField to prevent cache key conflicts.
}

'Setting a database file provider via a provider string (same as above):
'In a provider string, if a value contains semi-colon character, that value should be enclosed
'in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = "Type=Database; File=SomeFolder/SomeFile.ext; Connection String='Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI'; Table=SomeTable; Key Field=Path; Content Field=Content"
```

--------------------------------

### Configure DatabaseFileProvider in C#

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_Caching_DocumentCache_CreateCacheInfo.htm

Set up a DatabaseFileProvider to connect to a database file system. Key fields like KeyField and ContentField are mandatory.

```csharp
FileProvider fileProvider;

//Setting a DatabaseFileProvider instance,
//to connect to a database file system.
fileProvider = new DatabaseFileProvider
{
    File = "SomeFile.ext", //File can also be set as a relative path "SomeFolder/SomeFile.ext".
    ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    //ProviderName = "System.Data.SqlClient" //ProviderName default value is "System.Data.SqlClient"

    Table = "SomeTable", //Table default value is "File".

    //Mandatory fields:
    KeyField = "Path", //KeyField default value is "Id".
    ContentField = "Content", //ContentField default value is "Content".

    //Optional fields DateModifiedField and SizeField: used for detailed file info, e.g. for generating better cache keys.
    //NameField = "Name", //NameField used for overriding file name specified in File.
}
```

--------------------------------

### JavaScript Example for Page Changed Event

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerClientEvents_PageChanged.htm

An example of a JavaScript function that can be assigned to the PageChanged event to handle page change notifications and log event details.

```APIDOC
## JavaScript Page Changed Event Handler

### Description
This JavaScript function demonstrates how to handle the `pageChanged` event triggered by the DocumentViewer. It receives event arguments, accesses the DocumentViewer instance, and logs the event details to the console.

### Method
CLIENT-SIDE JAVASCRIPT FUNCTION

### Endpoint
N/A (Client-side script)

### Parameters
#### Event Arguments (e)
- **e.target**: The DocumentViewer instance that triggered the event.
- **e.detail**: An object containing details about the page change event, including:
  - **eventName** (string): The name of the event ('pageChanged').
  - **document** (string): The name of the document being viewed.
  - **pageNumber** (integer): The new page number.
  - **pageLabel** (string | null): The label of the new page, if available.
  - **previous** (integer): The previous page number.

### Request Example
```javascript
function documentViewerPageChanged(e) {
    var documentViewer = e.target;
    var json = JSON.stringify(e.detail, null, 2);
    console.log(json);
}
```

### Response
#### Success Response (200)
N/A (This is a client-side function)

#### Response Example
```json
{
  "eventName": "pageChanged",
  "document": "p4450.pdf",
  "pageNumber": 2,
  "pageLabel": null,
  "previous": 1
}
```
```

--------------------------------

### Configure FileSystemFileProvider with Specific User Credentials (VB)

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Sets up a FileSystemFileProvider to connect to a file location using explicit username and password. Values containing semicolons must be quoted.

```vbnet
'Setting a physical file provider via a provider string, to connect as a specific user (same as above):
'In a provider string, if a value contains semi-colon character, that value should be enclosed
'in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = "Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\share; User Name=USERNAME; Password=PASSWORD'"
```

--------------------------------

### Example JavaScript Function for Printing Event

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerClientEvents_Printing.htm

This JavaScript function is an example of how to handle the printing event. It receives event arguments, logs them to the console, and provides access to the DocumentViewer instance.

```javascript
function documentViewerPrinting(e) {
    var documentViewer = e.target;

    //Pretty print the event arguments
    var json = JSON.stringify(e.detail, null, 2);

    console.log(json);
}
```

--------------------------------

### Get or Set Display Language (VB)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_WebForms_DocumentViewerControl_DisplayLanguage.htm

Use this property to get or set the user interface language of the document viewer. It accepts two-letter language codes or specific culture codes.

```vb
Public Property DisplayLanguage As String
	Get
	Set
```

--------------------------------

### Configure FileSystemFileProvider with Web Server Authenticated Identity (VB Instance)

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Instantiates a FileSystemFileProvider and configures its Location to use the Web Server's authenticated user. Requires IIS authentication to be configured.

```vbnet
'Setting a physical file provider via a FileSystemFileProvider instance, to connect as the Web Server authenticated identity:
'For example, when you disable `Anonymous Authentication` And
'enable one of these authentication types for a web app in IIS:
'- `Windows Authentication (NTLM)`
'- `Digest Authentication (Negotiate)`
'- `Basic Authentication`
'Then IIS can pass the already authenticated user info to the web app.
'This user can then be impersonated by the web app when necessary, e.g. when accessing files.
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New PhysicalLocation() With {
        .Path = "\\server\share", 'Path can be a UNC path or a local path
        .AuthenticatedUser = AuthenticatedUser.WebServer
    }
}
```

--------------------------------

### Get or Set Display Language (C#)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_WebForms_DocumentViewerControl_DisplayLanguage.htm

Use this property to get or set the user interface language of the document viewer. It accepts two-letter language codes or specific culture codes.

```csharp
public string DisplayLanguage { get; set; }
```

--------------------------------

### Configure FileSystemFileProvider with Credentials

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_Convert_10.htm

Connect to UNC paths or protected local paths by specifying a username and password.

```C#
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};

//Setting a physical file provider via a provider string, to connect as a specific user (same as above):
//In a provider string, if a value contains semi-colon character, that value should be enclosed
//in single quotes (e.g. Password='PASS;WORD') or double quotes (e.g. Password="PASS;WORD").
fileProvider = @"Type=FileSystem; File=SomeFile.ext; Location='Path=\\server\\share; User Name=USERNAME; Password=PASSWORD'";
```

--------------------------------

### Example JavaScript Function for TextSelected Event

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerClientEvents_TextSelected.htm

This JavaScript function is an example of how to handle the textSelected event. It receives event arguments, logs them to the console, and demonstrates accessing document viewer properties.

```javascript
function documentViewerTextSelected(e) {
    var documentViewer = e.target;

    //Pretty print the event arguments
    var json = JSON.stringify(e.detail, null, 2);

    console.log(json);
}

//SAMPLE OUTPUT:
/*
{
  "eventName": "textSelected",
  "document": "p4450.pdf",
  "text": "We are intently focused on implementing new and innovative strategies "
}
*/
```

--------------------------------

### Configure DatabaseFileProvider in C#

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter_Convert_9.htm

Set up a DatabaseFileProvider to connect to a database file system. Key properties include File, ConnectionString, and Table.

```csharp
FileProvider fileProvider;

//Setting a DatabaseFileProvider instance,
//to connect to a database file system.
fileProvider = new DatabaseFileProvider
{
    File = "SomeFile.ext", //File can also be set as a relative path "SomeFolder/SomeFile.ext".
    ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    //ProviderName = "System.Data.SqlClient" //ProviderName default value is "System.Data.SqlClient"

    Table = "SomeTable", //Table default value is "File".

    //Mandatory fields:

```

--------------------------------

### Example JavaScript Function for DocumentViewer Errors

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerClientEvents_Failed.htm

This JavaScript function is an example of how to handle the 'failed' event. It receives event arguments, accesses the target DocumentViewer, and logs the event details to the console.

```javascript
function documentViewerFailed(e) {
    var documentViewer = e.target;

    //Pretty print the event arguments
    var json = JSON.stringify(e.detail, null, 2);

    console.log(json);
}
```

--------------------------------

### Configure Azure Blob FileProvider with Instance (C#)

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Instantiates a FileSystemFileProvider with an AzureBlobLocation to connect to Azure Blob storage. Requires container, account name, and account key.

```csharp
FileProvider fileProvider;

//Setting a FileSystemFileProvider instance with an AzureBlobLocation instance,
//to connect to Azure Blob cloud file system.
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new AzureBlobLocation
    {
        //Leave Path empty to connect to the root of the container. 
        //For connecting to subfolders, Path should be specified as a relative path (e.g. "some/folder")
        //Path = "some/folder",

        //Get these values from your Azure Portal (Storage Account -> Access Keys -> Connection String)
        Container = "CONTAINER",
        AccountName = "XXX",
        AccountKey = "XXX"
    }
};
```

--------------------------------

### JavaScript Example for Document Viewer Loaded Event

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerClientEvents_Loaded.htm

Provides an example JavaScript function to handle the `loaded` event. This function receives event arguments, including details about the loaded document, and logs them to the console.

```javascript
function documentViewerLoaded(e) {
    var documentViewer = e.target;

    //Pretty print the event arguments
    var json = JSON.stringify(e.detail, null, 2);

    console.log(json);
}

//SAMPLE OUTPUT:
/*
{
  "eventName": "loaded"
}
*/
```

--------------------------------

### Configure DatabaseFileProvider

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Initializes a database file provider using a connection string and table mapping. Ensure the database schema matches the provided SQL script.

```C#
fileProvider = "Type=Database; File=SomeFolder/SomeFile.ext; Connection String='Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI'; Table=SomeTable; Key Field=Path; Content Field=Content";
```

```SQL
CREATE TABLE [File] (
    [Id] [int] IDENTITY(1, 1) PRIMARY KEY,
    [Path] [nvarchar](500) NOT NULL UNIQUE,
    [Name] [nvarchar](100),
    [DateModified] [smalldatetime],
    [Size] [bigint],
    [Content] [varbinary](max)
);
```

```VB.NET
Dim fileProvider As FileProvider

fileProvider = New DatabaseFileProvider() With {
    .File = "SomeFile.ext",
    .ConnectionString = "Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI",
    .ProviderName = "System.Data.SqlClient",
    .Table = "SomeTable",
    .KeyField = "Path",
    .ContentField = "Content",
    .NameField = "Name",
    .DateModifiedField = "DateModified",
    .SizeField = "Size"
}

fileProvider = "Type=Database; File=SomeFolder/SomeFile.ext; Connection String='Data Source=(local); Initial Catalog=SomeDb; Integrated Security=SSPI'; Table=SomeTable; Key Field=Path; Content Field=Content"
```

--------------------------------

### Configure GleamTech with UseGleamTech

Source: https://docs.gleamtech.com/documentultimate/html/version-history.htm

Use the configure callback in UseGleamTech to set product-wide configurations such as logging and license keys.

```csharp
app.UseGleamTech(() =>
{
    GleamTechConfiguration.Current.LogEnabled = true;

    DocumentUltimateConfiguration.Current.LicenseKey = "QQJDJLJP34...";
});
```

--------------------------------

### Get or Set Active Highlight Color (C#)

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_AspNet_UI_DocumentViewerSearchOptions_ActiveHighlightColor.htm

Use this property to get or set the color for highlighting the active search result. The default color is orange. It supports implicit casting from various color types.

```csharp
public Color ActiveHighlightColor { get; set; }
```

--------------------------------

### Initialize DocumentUltimateConfiguration

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentUltimateConfiguration__ctor.htm

Constructor for creating a new configuration instance.

```C#
public DocumentUltimateConfiguration()
```

```VB
Public Sub New
```

--------------------------------

### Get Document Format Info by File Name (VB)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentFormatInfo_Get_1.htm

Use this method to get document format information by providing the file name, path, or extension. It returns a DocumentFormatInfo object or null if no match is found.

```vb
Public Shared Function Get ( 
	file As String
) As DocumentFormatInfo
```

--------------------------------

### Create FileSystemFileProvider with UNC path and credentials

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentConverter__ctor_1.htm

Configure a FileSystemFileProvider to connect to a UNC path or protected local path using specific user credentials. The UserName can be in various formats like 'Domain\User' or 'User@Domain'.

```csharp
//Setting a FileSystemFileProvider instance with a PhysicalLocation instance,
//to connect as a specific Windows user to a UNC path or a protected local path:
//UserName can be specified as "Domain\User", "User@Domain" (UPN format), "Machine\User", "User" (local user).
fileProvider = new FileSystemFileProvider
{
    File = "SomeFile.ext",
    Location = new PhysicalLocation
    {
        Path = @"\\server\share", //Path can be a UNC path or a local path
        UserName = "USERNAME",
        Password = "PASSWORD"
    }
};
```

--------------------------------

### Get Document Format Info by File Name (C#)

Source: https://docs.gleamtech.com/documentultimate/html/M_GleamTech_DocumentUltimate_DocumentFormatInfo_Get_1.htm

Use this method to get document format information by providing the file name, path, or extension. It returns a DocumentFormatInfo object or null if no match is found.

```csharp
public static DocumentFormatInfo Get(
	string file
)
```

--------------------------------

### Get or Set Render Foreground Color - VB

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_CadInputOptions_RenderForegroundColor.htm

Gets or sets the foreground color of the drawing when it's rendered. The default is null, which means foreground colors will be kept same as in the drawing. When set, all foreground colors will be fixed to this same color.

```vb
Public Property RenderForegroundColor As Color?
	Get
	Set
```

--------------------------------

### Configure Azure Blob FileProvider with Instance (VB)

Source: https://docs.gleamtech.com/documentultimate/html/T_GleamTech_DocumentUltimate_DocumentConverter.htm

Instantiates a FileSystemFileProvider with an AzureBlobLocation for connecting to Azure Blob storage. Path can be left empty for the root or specified for subfolders.

```vbnet
Dim fileProvider As FileProvider

'Setting a FileSystemFileProvider instance with an AzureBlobLocation instance,
'to connect to Azure Blob cloud file system.
'Leave Path empty to connect to the root of the container. 
'For connecting to subfolders, Path should be specified as a relative path (e.g. "some/folder")
'Path = "some/folder",
'Get these values from your Azure Portal (Storage Account -> Access Keys -> Connection String)
fileProvider = New FileSystemFileProvider() With {
    .File = "SomeFile.ext",
    .Location = New AzureBlobLocation() With {
        .Container = "CONTAINER",
        .AccountName = "XXX",
        .AccountKey = "XXX"
    }
}
```

--------------------------------

### Get or Set Render Foreground Color - C#

Source: https://docs.gleamtech.com/documentultimate/html/P_GleamTech_DocumentUltimate_CadInputOptions_RenderForegroundColor.htm

Gets or sets the foreground color of the drawing when it's rendered. The default is null, which means foreground colors will be kept same as in the drawing. When set, all foreground colors will be fixed to this same color.

```csharp
public Color? RenderForegroundColor { get; set; }
```
Tokens:
Raw