Click or drag to resize

PdfFieldCollectionNeedAppearances Property

Gets or sets a value representing whether a PDF reader should construct appearance streams and appearance dictionaries for form fields in the document.

Namespace:  RadPdf.Data.Document.Objects.FormFields
Assembly:  RadPdfStandard (in RadPdfStandard.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
Copy
public bool NeedAppearances { get; set; }

Property Value

Type: Boolean
Remarks

If this document was created from a PDF, the value of the NeedAppearances flag in the original file is the document default. Otherwise, the default value is false.

If a value of false is specified, RAD PDF automatically generates the appearance streams for all form fields.

If PDF form field values do not appear correctly when opened in third-party viewers, a value of true will force compliant PDF readers to render the fields (slightly slowing the speed with which the document can be displayed). This can be especially helpful if non-ASCII / non-ANSI characters are appearing as "?".

Examples
The following example uses a PdfIntegrationProvider to create a custom Integration Provider which will set NeedAppearances to true for all documents as they are saved.
C#
Copy
using System;
using System.Web;

using RadPdf.Integration;

public class CustomPdfIntegrationProvider : PdfIntegrationProvider
{
    public override void OnDocumentSaving(DocumentSavingEventArgs e)
    {
        base.OnDocumentSaving(e);

        // Set that a PDF reader should construct the appearance for
        // form fields in the document.
        e.Document.Fields.NeedAppearances = true;
    }
}
The following Program.cs file registers the above custom Integration Provider. This example assumes that CustomPdfIntegrationProvider is in namespace referenced by your ASP.NET web application.
C#
Copy
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

using RadPdf;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddSession();

var app = builder.Build();

app.UseStaticFiles();

app.UseRouting();

app.UseSession();

app.UseAuthorization();

// Or however you normally process page requests
app.MapRazorPages();

// Create middleware settings
RadPdfCoreMiddlewareSettings settings = new RadPdfCoreMiddlewareSettings()
{
    // Add SQL Server Connection String, if not using Lite Documents
    // Sample connection string below connects to a SQL Server Express instance on localhost
    // TrustServerCertificate=True is set to avoid a trust exception (e.g. "The certificate chain was issued by an authority that is not trusted.")
    ConnectionString = @"Server=.\SQLExpress;Database=RadPdf;Trusted_Connection=Yes;TrustServerCertificate=True;",

    // Add License Key
    LicenseKey = "DEMO",

    // Attach the Integration Provider
    IntegrationProvider = new CustomPdfIntegrationProvider()

    // To run RAD PDF without the System Service, add UseService = false
    // If using Lite Documents without the System Service, a LiteStorageProvider must also be implemented
    //UseService = false
};

// Add RAD PDF's middleware to app
app.UseRadPdf(settings);

app.Run();
See Also