### SLU deploy get example - basic Source: https://help.accusoft.com/BarcodeXpress/latest/BxLinuxCC/slu-command-line-mode.html Example command to obtain and install a Runtime License using the 'deploy get' command with a configuration file and solution name. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" ``` -------------------------------- ### SLU deploy get example - with access key Source: https://help.accusoft.com/BarcodeXpress/latest/BxLinuxCC/slu-command-line-mode.html Example command to obtain and install a Runtime License using the 'deploy get' command with an access key for annual Runtime Licensing. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" Your-Access-Key ``` -------------------------------- ### SLU deploy get example - with outputurl Source: https://help.accusoft.com/BarcodeXpress/latest/BxLinuxCC/slu-command-line-mode.html Example command to obtain and install a Runtime License with error handling to automatically output the URL and system Hardware Key for licensing through the web portal if there is a connectivity error. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" outputurl ``` -------------------------------- ### LDK Offline License Installation Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/Using_the_LDK_when_the_Target_Machine_Does_Not_Have_Internet_Access_%28Offline_Mode%29.html This example shows how to check for an existing license, attempt automatic retrieval, and handle the offline case by getting a hardware key. It also includes the manual installation of a license key obtained from a system with internet access. ```C# // Instantiate the LDK ActiveX component IDeploymentComponent ldk = new DeploymentComponent(); // Set the path to the configuration file provided // when the runtime licenses were purchased. ldk.ConfigPath = @"C:\config.txt"; //Check to see if a license is currently on the machine //If so, then there’s no need to proceed If (ldk.LicKey != "") { MessageBox.Show("A license already exists on this machine."); return; } // Attempt to get the next available license. // Pass an Access Key as a parameter if you are using annual licensing or have opted to use Access Keys ldk.GetLicKeyAuto(""); if (ldk.ResultCode != enumLdkErrorCodes.LDK_SUCCESS) { // Automatic Registration Failed - A temporary license // has been installed but will expire in 14 days. // You will need to add code to notify your user of this issue and the 14 day // expiration. if (ldk.ResultCode == enumLdkErrorCodes.LDK_ERR_INET_CONN_BROKEN) { // You will need to handle what happens when your user does not have an internet connection on the target machine. // Get the hardware key for the target system. Note // that you may optionally pass an Access Key string hardwareKey = ldk.GetHdwKey(""); // Write the hardware key to some type of removable media. // Uncomment the next line and use your custom method ... // ApplicationSpecificMethodToWriteHardwareKey(hardwareKey); } } else { // The license has been registered and installed. } ``` ```C# // After taking the hardware key to a system with an Internet // connection and acquiring the license key string from the // manual registration website, read the key into your // application. // Uncomment the next line and use your custom method … // string manuallyAcquiredLicenseKey = ApplicationSpecificMethodToReadLicenseKey(); // Install the license key ldk.LicKey = manuallyAcquiredLicenseKey; ``` -------------------------------- ### JDK installation path example Source: https://help.accusoft.com/RasterMaster/v20.21/docs/java-samples Example of a Windows JDK installation directory path. ```text C:\Program Files\Java\jdk-11.0.2\bin ``` -------------------------------- ### Obtain and Install Runtime License Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/slu-command-line-mode.html Example command to obtain and install a runtime license using a configuration file and solution name. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" ``` -------------------------------- ### Visual Basic usage example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.SimplifiedMetadata~ImageGear.Formats.XMP.EXIF.ImGearXMPCFAPattern~Values.html Visual Basic usage example showing how to set and get the Values property. ```vb 'Usage Dim instance As ImGearXMPCFAPattern Dim value As ImGearXMPSeq(Of ImGearXMPInteger) instance.Values = value value = instance.Values ``` -------------------------------- ### Obtain and install Runtime License with deploy get Source: https://help.accusoft.com/SmartZone/v8.0/dotnet/slu-command-line-mode.html Command to obtain and install a Runtime License from the service. Requires a configuration file and solution name. Java must be installed. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" ``` -------------------------------- ### Example: installsdk with access key and credentials Source: https://help.accusoft.com/BarcodeXpress/latest/BxLinuxCC/command-line-mode.html Example command for installing a toolkit license using a specific access key, email, and password. ```bash java -jar licensemanager.jar installsdk 85EXGW2H3GP3H6P63777 johndoe@acmecorp.com johndoepassword ``` -------------------------------- ### SLU deploy write example with license key Source: https://help.accusoft.com/ImageGear/latest/slu-command-line-mode.html Example of installing a Runtime License generated through the web portal. Replace 'YourSolutionName' and '2.0.YourDeploymentLicenseKey' with actual values. ```text java –jar slu.jar deploy write "YourSolutionName"2.0.YourDeploymentLicenseKey ``` -------------------------------- ### Start Field Usage Visual Basic Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Core~ImageGear.Core.ImGearChannelRange~Start.html Example showing how to get and set the Start field in Visual Basic. ```vb 'Usage Dim instance As ImGearChannelRange Dim value As Integer value = instance.Start instance.Start = value ``` -------------------------------- ### getStartPoint() example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/IPCC.Mark.html Shows how to get the start point of a LineAnnotation mark. The example checks if the method exists before calling it and assigns the result to a variable. ```javascript if (mark.getStartPoint) { var startPoint = mark.getStartPoint(); } ``` -------------------------------- ### SLU deploy write example Source: https://help.accusoft.com/BarcodeXpress/latest/BxLinuxCC/slu-command-line-mode.html Example command to install a Runtime License generated through the web portal using the 'deploy write' command. ```bash java –jar slu.jar deploy write "YourSolutionName" 2.0.YourDeploymentLicenseKey ``` -------------------------------- ### getStartIndexInInput() Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/IPCC.SearchTaskResult.html Gets the start index of the search result text within the entire text string that was searched. ```javascript var mark1 = viewerControl.addMark(1, "TextAnnotation"); mark1.setText("When Full-Text Search is being installed for an existing client without Full-Text Search"); var searchTask = new IPCC.SearchTask(searchQuery); var results = searchTask.search(mark1.getText()); var result = results[0]; var startIndex = result.getStartIndexInInput(); alert("The search result starts a character " + startIndex + " in the text string."); ``` -------------------------------- ### getStartIndexInContext() Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/IPCC.SearchTaskResult.html Gets the start index of the search result text within the context text returned by IPCC.SearchResult#getContext. ```javascript var mark1 = viewerControl.addMark(1, "TextAnnotation"); mark1.setText("When Full-Text Search is being installed for an existing client without Full-Text Search"); var searchTask = new IPCC.SearchTask(searchQuery); var results = searchTask.search(mark1.getText()); var result = results[0]; var startIndex = result.getStartIndexInContext(); ``` -------------------------------- ### Example: List Available Toolkit Licenses Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/command-line-mode.html Example command showing how to list available toolkit licenses with a specific email and password. ```bash java -jar licensemanager.jar getsdklist johndoe@acmecorp.com johndoepassword ``` -------------------------------- ### getPageNumber() example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/PCCViewer.PiiEntity.html Gets the page number where the PII entity starts. If the entity spans multiple pages, the first page number is returned. ```javascript var piiEntities = piiDetectionRequest.getPiiEntities() var piiEntity = piiEntities[0]; var pageNumber = piiEntity.getPageNumber(); alert("PII entity found on page: " + pageNumber); ``` -------------------------------- ### Obtain and Install Runtime License with Access Key Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/slu-command-line-mode.html Example command to obtain and install a runtime license using a configuration file, solution name, and access key. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" Your-Access-Key ``` -------------------------------- ### Unattended Install with start /wait Source: https://help.accusoft.com/PrizmDoc/latest/HTML/windows-unattended-install-and-uninstall.html Runs the unattended install with the start /wait command to wait for completion. Without it, the install starts in the background and returns immediately on a console or script. ```powershell > start /wait PrizmDocServer.exe ServiceUser=accusoft.com\PrizmUser ServicePassword=pdpassword DatabaseConnectionString=mysql://prizm-user:password@prizm-server.database.host:3306/prizmdoc_server_db -s -l output.log ``` -------------------------------- ### getStartIndexInPage() example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/PCCViewer.PiiEntity.html Gets the character index where the PII entity text starts within the page's full text. Use PCCViewer.ViewerControl#requestPageText to obtain the page text and PCCViewer.PiiEntity#getText for the entity text. ```javascript var piiEntities = piiDetectionRequest.getPiiEntities() var piiEntity = piiEntities[0]; var startIndex = piiEntity.getStartIndexInPage(); alert("The PII entity starts at character " + startIndex + " on the page."); ``` -------------------------------- ### Complete example combining documents to PDF Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/combine-to-pdf.html A complete, runnable example that creates a PrizmDocServerClient, combines documents with CombineToPdfAsync, and saves the result to 'output.pdf'. Includes necessary using directives and a MainAsync method. ```csharp using System; using System.IO; using System.Threading.Tasks; using Accusoft.PrizmDocServer; using Accusoft.PrizmDocServer.Conversion; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Take a DOCX file and replace its cover page with a boilerplate cover, // append a boilerplate back page, and then produce a new PDF. ConversionResult result = await prizmDocServer.CombineToPdfAsync( new[] { // start with a boilerplate cover page new ConversionSourceDocument("boilerplate-cover-page.pdf"), // keep all but the first page of the "main" document new ConversionSourceDocument("project-proposal.docx", pages: "2-"), // end with a boilerplate back page new ConversionSourceDocument("boilerplate-back-page.pdf") } ); // Save the result to "output.pdf". await result.RemoteWorkFile.SaveAsync("output.pdf"); } } } ``` -------------------------------- ### Complete Convert to PDF Example Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/convert-to-pdf.html Complete example showing client creation, conversion of a DOCX file to PDF, and saving the result. ```csharp using System; using System.IO; using System.Threading.Tasks; using Accusoft.PrizmDocServer; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Take a DOCX file and convert it to a PDF. ConversionResult result = await prizmDocServer.ConvertToPdfAsync("project-proposal.docx"); // Save the result to "output.pdf". await result.RemoteWorkFile.SaveAsync("output.pdf"); } } } ``` -------------------------------- ### CADLine.Point0 Property Syntax Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.Vector~ImageGear.Formats.CAD.CADLine~Point0.html Syntax for the Point0 property of the CADLine class, which gets or sets the start point of the line as an array of doubles. The Visual Basic usage example shows how to assign and retrieve the property value. ```C# public double[] Point0 {get; set;} ``` ```Managed Extensions for C++ public: __property double[]* get_Point0(); public: __property void set_Point0( double[][]* _value_ ); ``` ```C++/CLI public: property array^ Point0 { array^ get(); void set ( array^ _value_); } ``` ```Visual Basic 'Declaration Public Property Point0 As Double() ``` ```Visual Basic 'Usage Dim instance As CADLine Dim value() As Double instance.Point0 = value value = instance.Point0 ``` -------------------------------- ### Complete example: Create PNG thumbnail of first page Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/thumbnail-first-page.html A complete, runnable example that extracts the first page to a temporary PDF, converts it to a PNG with max dimensions, and saves the result. Includes necessary using directives and namespace. ```csharp using System; using System.IO; using System.Linq; using System.Threading.Tasks; using Accusoft.PrizmDocServer; using Accusoft.PrizmDocServer.Conversion; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Extract the first page as an intermediate PDF. We won't ever bother // downloading this from PrizmDoc Server. var tempFirstPagePdf = await prizmDocServer.ConvertToPdfAsync(new ConversionSourceDocument("project-proposal.docx", pages: "1")); // Convert the PDF to PNGs, specifying a max width and height. We'll get // back a collection of results, one per page. In our case, there is only // one page. IEnumerable thumbnailPngs = await prizmDocServer.ConvertAsync(new ConversionSourceDocument(tempFirstPagePdf.RemoteWorkFile), new DestinationOptions(DestinationFileFormat.Png) { PngOptions = new PngDestinationOptions() { MaxWidth = "512px", MaxHeight = "512px" } }); // Save the single result. await thumbnailPngs.Single().RemoteWorkFile.SaveAsync("thumbnail.png"); } } } ``` -------------------------------- ### Get start index in page of a search result Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/IPCC.SearchResult.html Gets the start index of the search result text within the entire text of the page it is on. Use requestPageText to get the full page text and getText to get the matched text. ```javascript var results = searchRequest.getResults() var result = results[0]; var startIndex = result.getStartIndexInPage(); alert("The search result starts a character " + startIndex + " on the page."); ``` -------------------------------- ### ImGearColorBookSettings Constructor and ShowDialog Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Windows.Forms~ImageGear.Windows.Forms.ImGearColorBookSettings.html Example demonstrating how to create an instance of ImGearColorBookSettings and display it as a modal dialog. ```APIDOC ## ImGearColorBookSettings Constructor and ShowDialog Example ### Description Creates a new instance of the ImGearColorBookSettings class and displays it as a modal dialog box. ### Syntax ```csharp using (ImGearColorBookSettings dlg = new ImGearColorBookSettings(igPageView)) { dlg.ShowDialog(igPageView.Parent); } ``` ```vb Using dlg As New ImGearColorBookSettings(igPageView) dlg.ShowDialog(igPageView.Parent) End Using ``` ### Parameters - **igPageView** (ImGearPageView) - The page view control that the color book settings dialog is associated with. ### Remarks This example demonstrates how to instantiate the ImGearColorBookSettings dialog and display it modally. The dialog is disposed after use. ``` -------------------------------- ### Target Property Syntax in C#, C++, and Visual Basic Source: https://help.accusoft.com/ImageGear/latest/ImageGear.Core~ImageGear.Formats.XMP.DynamicMedia.ImGearXMPMarker~Target.html Shows the syntax for the Target property in C#, Managed Extensions for C++, C++/CLI, and Visual Basic. The property gets or sets the part of the URL following the # sign, for example, in http://ns.adobe.com/xmp#Start, the value is Start. The property value is an ImageGear.Formats.XMP.ImGearXMPString class value. ```csharp public ImGearXMPString Target {get; set;} ``` ```cpp public: __property ImGearXMPString* get_Target(); public: __property void set_Target( ImGearXMPString* _value_ ); ``` ```cpp-cli public: property ImGearXMPString^ Target { ImGearXMPString^ get(); void set ( ImGearXMPString^ _value_); } ``` ```vb 'Declaration Public Property Target As ImGearXMPString ``` ```vb 'Usage Dim instance As ImGearXMPMarker Dim value As ImGearXMPString instance.Target = value value = instance.Target ``` -------------------------------- ### Install Web Portal Generated Runtime License Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/slu-command-line-mode.html Example command to install a runtime license key generated via the web portal. ```bash java –jar slu.jar deploy write "YourSolutionName" "2.0.YourDeploymentLicenseKey" ``` -------------------------------- ### GET viewing package example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/v3-viewing-packages.html Example request and response for GET /v3/viewingPackages/{packageId}. The response includes expirationDateTime, creationDateTime, bytes, and lifetimeAfterLastUse properties. ```http GET /v3/viewingPackages/U3BlY2lhbCBPcmRlciAjOTM3 ``` ```http HTTP 200 OK Content-Type: application/json { "expirationDateTime": "2122-07-03T00:00:00.000Z", "creationDateTime": "2101-01-01T0:00:00.000Z", "bytes": 180924609, "lifetimeAfterLastUse": "30d" } ``` -------------------------------- ### Get start index in context of a search result Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/IPCC.SearchResult.html Gets the start index of the search result text within the context text returned by getContext. ```javascript var results = searchRequest.getResults(); var result = results[0]; var startIndex = result.getStartIndexInContext(); ``` -------------------------------- ### Obtain and Install Runtime License with Error Handling Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/slu-command-line-mode.html Example command to obtain and install a runtime license, including the outputurl flag to handle connectivity errors by outputting the URL and Hardware Key. ```bash java –jar slu.jar deploy get "/Path to/YourSolutionName_Config.txt" "YourSolutionName" outputurl ``` -------------------------------- ### IImGearARTRuler.StartPoint Property Syntax Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Art~ImageGear.ART.IImGearARTRuler~StartPoint.html Syntax for the StartPoint property of the IImGearARTRuler interface in multiple languages. The property gets or sets the start point of the mark as an ImGearPoint structure. The Visual Basic usage example shows how to assign and retrieve the property value. ```C# ImGearPoint StartPoint {get; set;} ``` ```Managed Extensions for C++ __property ImGearPoint get_StartPoint(); __property void set_StartPoint( ImGearPoint _value_ ); ``` ```C++/CLI property ImGearPoint StartPoint { ImGearPoint get(); void set ( ImGearPoint _value_); } ``` ```Visual Basic 'Declaration Property StartPoint As ImGearPoint ``` ```Visual Basic 'Usage Dim instance As IImGearARTRuler Dim value As ImGearPoint instance.StartPoint = value value = instance.StartPoint ``` -------------------------------- ### Setting licensing with C# Source: https://help.accusoft.com/ImageGear/latest/ImageGear.Core~ImageGear.Core.ImGearLicense.html Example of setting solution name, solution key, and OEM license key in C#. ```C# // Solution Name, Key, and License Key provided by AccuSoft for your deployment. ImGearLicense.SetSolutionName("YourSolutionName"); ImGearLicense.SetSolutionKey(12345, 12345, 12345, 12345); ImGearLicense.SetOEMLicenseKey("2.0.AStringForOEMLicensingContactAccusoftSalesForMoreInformation..."); ``` -------------------------------- ### Silent Installation with Sample Installation Source: https://help.accusoft.com/PrizmDoc/latest/HTML/pas-windows-installation-unattended.html Runs PrizmDocClient.exe silently to install PAS with HTML5 samples. Requires IIS to be installed. Sets SelectedClientFeatures to "ProductFeature,HTML5Viewer" and enables IIS configuration and re-registration. Logs to output.log. ```batch > start /wait PrizmDocClient.exe ServiceUser="accusoft.com\PrizmDocUser" ServicePassword="PrizmDocPassword" SelectedClientFeatures="ProductFeature,HTML5Viewer" SelectedPASFeatures="ALL" DatabaseAdapter="mysql" DatabaseConnectionString="mysql://yusername:password@localhost:3306/prizmdb" IISConfigureSamples="1" IISReregister="1" -s -l output.log ``` -------------------------------- ### Start Field Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Core~ImageGear.Core.ImGearChannelRange~Start.html Gets or sets the start channel in the channel range. ```APIDOC ## Start Field ### Description Start channel in the channel range. ### Syntax #### Visual Basic ```vb Public Start As Integer ``` #### C# ```csharp public int Start ``` #### Managed Extensions for C++ ```cpp public: int Start ``` #### C++/CLI ```cpp public: int Start ``` ### Field Value Integer value in the range of 0 .. maximum channel number. ``` -------------------------------- ### get Method Usage Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Web.UI~ImageGear.Web.UI.ContextMenu~get.html Example usage of the get method on an instance of ContextMenu. ```JavaScript var resultVar = instanceOfContextMenu.get(Number); ``` -------------------------------- ### C# Example for ImGearColorBookProperties Constructor Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Windows.Forms~ImageGear.Windows.Forms.ImGearColorBookProperties~_ctor.html C# example showing how to create and show the ImGearColorBookProperties dialog using a color book and the parent of igPageView. ```csharp if (curBook != null) { using (ImGearColorBookProperties dlg = new ImGearColorBookProperties(curBook)) { dlg.ShowDialog(igPageView.Parent); } } ``` -------------------------------- ### GET /v2/searchTasks/{processId} Request Example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/search-tasks.html Example request to get information about a search task. The request includes the processId in the URL and the Accusoft-Affinity-Token header, which is required when server clustering is enabled. ```http GET prizmdoc_server_base_url/v2/searchTasks/pR5X6nPDgMwat6cxlmn0Q3 Accusoft-Affinity-Token: ejN9/kXEYOuken4Pb9ic9hqJK45XIad9CgQ+BkM= ``` -------------------------------- ### C# Example: CreateFromMinMax64 Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.Dicom~ImageGear.Formats.DICOM.ImGearVOIWindow~CreateFromMinMax64.html C# example that creates an ImGearVOIWindow using the CreateFromMinMax64 method with literal values 1024 and 2048. ```csharp ImGearVOIWindow window64 = ImGearVOIWindow.CreateFromMinMax64(1024, 2048); ``` -------------------------------- ### Usage Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Art~ImageGear.ART.ImGearARTProtractor~FontStyleART.html Example showing how to get and set the FontStyleART property on an instance of ImGearARTProtractor. ```vbnet 'Usage Dim instance As ImGearARTProtractor Dim value As ImGearARTFontStyles instance.FontStyleART = value value = instance.FontStyleART ``` -------------------------------- ### C# Example: Creating and Adding a Color Book Source: https://help.accusoft.com/ImageGear/latest/ImageGear.Core~ImageGear.Core.ImGearColorBook~_ctor%28ImGearSpotColorVendorID%2CString%2CString%2CString%2CString%2CString%2CInt32%2CInt32%2CImGearColorSpaceIDs%29.html Shows how to initialize the color books, create a new ImGearColorBook, add colors to it, and add it to the ImGearColorBooks collection. ```csharp ImGearColorBooks.Initialize(files); ImGearColorBook book = new ImGearColorBook(ImGearSpotColorVendorID.PantoneProcess, "", "My Color Book", "Prefix", "Postfix", "Description", 2, 2, ImGearColorSpaceIDs.LAB); ImGearPixel p = new ImGearPixel(3, 8); p[0] = 138; p[1] = 202; p[2] = 169; book.Add(new ImGearColorBookColor("PANTONE Red 032 C", 90452819915331, p, ImGearColorSpaceIDs.LAB)); p[0] = 48; p[1] = 160; p[2] = 54; book.Add(new ImGearColorBookColor("PANTONE reflex Blue C", 90457418519875, p, ImGearColorSpaceIDs.LAB)); ImGearColorBooks.Add(book); ``` -------------------------------- ### GET FormInfo request example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/form-extractors.html Example request to the GET /PCCIS/V1/ViewingSession/u{viewingSessionId}/FormInfo endpoint. It returns what kind of form field data, if any, is available in the viewing session's source document. ```http GET /PCCIS/V1/ViewingSession/uDLbVh9sTmXJAmd1GeXbS9Gn3WHxs8oib2xPsW2xEFjnIDdoJcudPtxciodSYFQq6zYGabQ_rJIecdbkImTTkSA/FormInfo ``` -------------------------------- ### demo.config example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/dev-guide-configure-demo-on-windows.html Example configuration file for the demo. It sets the console log file path, HTTP service port, and API service host and port. The file is used to customize the application host address, application port, and services port. ```json { "logging": { "consoleLogFilePath": "%ALLUSERSPROFILE%\Accusoft\Prizm\Logs\CssDemoService.console.log" }, "httpService": { "port": 3000 }, "apiService": { "port": 18681, "host": "localhost" } } ``` -------------------------------- ### Initialize Method Usage Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.Pdf~ImageGear.Formats.PDF.ImGearPDF~Initialize%28%29.html Example of how to invoke the Initialize method. ```C# 'Usage   ImGearPDF.Initialize() ``` -------------------------------- ### Install Evaluation License Source: https://help.accusoft.com/ScanFixXpress/V8.1/dotnet/topic32.html Example of installing an evaluation license using the Licensing Development Kit. ```APIDOC ## Install Evaluation License ### Description Installs an evaluation license for purchased runtime products using the Licensing Development Kit. ### Method N/A ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // Instantiate the LDK ActiveX component IDeploymentComponent ldk = new DeploymentComponent(); // Set the path to the configuration file provided // when the runtime licenses were purchased. ldk.ConfigPath = @"C:\config.txt"; // Install an evaluation license ldk.StartEvalPeriod(); ``` ### Response #### Success Response (200) None #### Response Example None ### Error Handling None ``` -------------------------------- ### Visual Basic Init method usage Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.Vector~ImageGear.Vector.ImGearVectorVertexCont~Init.html Visual Basic usage example for the Init method, showing how to call it on an instance. ```vb 'Usage Dim instance As ImGearVectorVertexCont Dim vertexCount As Integer instance.Init(vertexCount) ``` -------------------------------- ### Get start point of a LineAnnotation Source: https://help.accusoft.com/PrizmDoc/latest/HTML/PCCViewer.Mark.html Retrieves the start point coordinates for marks of type LineAnnotation. ```javascript if (mark.getStartPoint) { var startPoint = mark.getStartPoint(); } ``` -------------------------------- ### Set Solution Name, Key, and OEM License Key Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Core~ImageGear.Core.ImGearLicense.html Example of setting the solution name, solution key, and OEM license key. The values are placeholders provided by AccuSoft for your deployment. ```C# // Solution Name, Key, and License Key provided by AccuSoft for your deployment. ImGearLicense.SetSolutionName("YourSolutionName"); ImGearLicense.SetSolutionKey(12345, 12345, 12345, 12345); ImGearLicense.SetOEMLicenseKey("2.0.AStringForOEMLicensingContactAccusoftSalesForMoreInformation..."); ``` ```Visual Basic 'Solution Name, Key, and License Key provided by Accusoft for your deployment. ImGearLicense.SetSolutionName("YourSolutionName") ImGearLicense.SetSolutionKey(12345, 12345, 12345, 12345) ImGearLicense.SetOEMLicenseKey("2.0.AStringForOEMLicensingContactAccusoftSalesForMoreInformation...") ``` -------------------------------- ### ThumbnailBackgroundColor Usage Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Web~ImageGear.Web.UI.ImGearThumbnailList~ThumbnailBackgroundColor.html Example showing how to get and set the ThumbnailBackgroundColor property in Visual Basic. ```vbnet 'Usage   Dim instance As ImGearThumbnailList Dim value As String   instance.ThumbnailBackgroundColor = value   value = instance.ThumbnailBackgroundColor ``` -------------------------------- ### Complete Example: ConvertToPdfAsync with Headers and Footers Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/headers-and-footers-pdf.html Complete example that converts a DOCX file to PDF with headers and footers, then saves the result. Includes necessary using directives and a Main method that calls an async method. ```csharp using System; using System.Collections.Generic; using System.IO; using System.Threading.Tasks; using Accusoft.PrizmDocServer; using Accusoft.PrizmDocServer.Conversion; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { File.Delete("output.pdf"); var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Take a DOCX file, append headers and footers to each page (expanding // the page size), and convert it to a PDF. ConversionResult result = await prizmDocServer.ConvertToPdfAsync("project-proposal.docx", header: new HeaderFooterOptions { Color = "#0000FF", // blue Lines = new List { new HeaderFooterLine { Left = "Top Left", Center = "Top", Right = "Top Right" }, new HeaderFooterLine { Center = "Page {{pageNumber}} of {{pageCount}}" }, } }, footer: new HeaderFooterOptions { Color = "#FF0000", // red Lines = new List { new HeaderFooterLine { Center = "BATES{{pageNumber+4000,10}}" }, new HeaderFooterLine { Left = "Bottom Left", Center = "Bottom", Right = "Bottom Right" }, } } ); // Save the result to "output.pdf". await result.RemoteWorkFile.SaveAsync("output.pdf"); } } } ``` -------------------------------- ### Record2Version Usage Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.SimplifiedMetadata~ImageGear.Formats.IPTC.ImGearIPTCMetadata~Record2Version.html Example demonstrating how to get and set the Record2Version property on an instance of ImGearIPTCMetadata. ```vb 'Usage   Dim instance As ImGearIPTCMetadata Dim value As Nullable(Of UShort)   instance.Record2Version = value   value = instance.Record2Version ``` -------------------------------- ### Visual Basic usage example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Art~ImageGear.ART.ImGearARTRuler~AspectDenominatorY.html Visual Basic usage example for getting and setting AspectDenominatorY. ```vb 'Usage Dim instance As ImGearARTRuler Dim value As Integer instance.AspectDenominatorY = value value = instance.AspectDenominatorY ``` -------------------------------- ### Complete Example: Convert DOCX to JPEGs Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/convert-pages-to-jpegs.html Complete example that creates a PrizmDocServerClient, converts a DOCX file to JPEGs, and saves each page. Includes necessary using directives and async entry point. ```csharp using System; using System.Linq; using System.Threading.Tasks; using Accusoft.PrizmDocServer; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Take a DOCX file and convert each of its pages to a JPEG. IEnumerable results = await prizmDocServer.ConvertAsync("project-proposal.docx", DestinationFileFormat.Jpeg); // Save each result to a JPEG file. for (var i=0; i < results.Count(); i++) { await results.ElementAt(i).RemoteWorkFile.SaveAsync($"page-{i+1}.jpg"); } } } } ``` -------------------------------- ### Visual Basic (Usage) Create Method Syntax Source: https://help.accusoft.com/BarcodeXpress/latest/BxNetCore/Accusoft.BarcodeXpress14.NetCore~Accusoft.BarcodeXpressSdk.WriterBase~Create.html Visual Basic usage example for the Create method. Shows how to call the method on a WriterBase instance and store the returned IntPtr. ```Visual Basic (Usage) Dim instance As WriterBase Dim value As IntPtr value = instance.Create() ``` -------------------------------- ### C# example: Get Performance property Source: https://help.accusoft.com/BarcodeXpress/latest/BxNetCore/Accusoft.BarcodeXpress14.NetCore~Accusoft.BarcodeXpressSdk.BarcodeXpress~Performance.html Example of retrieving the Performance property into a string variable. ```csharp ... // Get the Performance and put in the string perf string perf = bcXpress.Performance ... ``` -------------------------------- ### Start the Server Licensing Utility (SLU) with java -jar Source: https://help.accusoft.com/BarcodeXpress/latest/BxNodeJs/server-licensing-utility.html Run this command in the licensing directory to start the SLU. Windows requires administrative privileges. The command launches the utility that registers a Runtime license on the system. ```bash java -jar ./slu.jar ``` -------------------------------- ### Example Response Body for GET Viewing Package Source: https://help.accusoft.com/PrizmDoc/latest/HTML/pre-convert.html Example response body for a successful GET request to a viewing package. Shows the JSON structure with input source details, state, and expiration date. ```json 200 OK Content-Type: application/json { "input": { "source": { "type": "document", "fileName": "sample.doc", "documentId": "unT67Fxekm8lk1p0kPnyg8", . . . }, "viewingPackageLifetime": 2592000 }, "state": "complete", "packageExpirationDateTime": "2016-1-09T06:22:18.624Z" } ``` -------------------------------- ### Start PrizmDoc Server service Source: https://help.accusoft.com/PrizmDoc/latest/HTML/ts-windows-installation-upgrade-failures.html Starts the PrizmDoc Server service via the net command. Used to verify the server starts successfully after installation. ```cmd net start prizm ``` -------------------------------- ### Example pcc.nix.yml (pas service) configuration Source: https://help.accusoft.com/PrizmDoc/latest/HTML/ai-getting-started.html Complete example of a pcc.nix.yml file for the PAS service. Sets the port to 3000, specifies license and solution names, configures the PrizmDoc Server connection, and sets storage paths for documents, markup, and other data. Includes a MySQL database connection string. ```yaml port: 3000 license.key: "YOUR_LICENSE_KEY" license.solutionName: "YOUR_SOLUTION_NAME" secretKey: "mysecretkey" pccServer.hostName: "prizmdoc-server" pccServer.port: 18681 pccServer.scheme: "http" logs.path: "/logs" defaults.viewingSessionTimeout: "20m" documents.storage: "filesystem" documents.path: "/data/documents" documents.legacyMode: true markupXml.storage: "filesystem" markupXml.path: "/data/markup" markupXml.legacyMode: true markupLayerRecords.storage: "filesystem" markupLayerRecords.path: "/data/markupLayerRecords" markupLayerRecords.legacyMode: true formDefinitions.storage: "filesystem" formDefinitions.path: "/data/formDefinitions" imageStamps.storage: "filesystem" imageStamps.path: "/data/imageStamp" imageStamps.validTypes: ["png", "jpg", "jpeg", "gif"] viewingSessionsData.storage: "database" viewingSessionsProcessesMetadata.storage: "database" database.adapter: mysql database.connectionString: "mysql://root:insecurelocal@database:3306/prizmdoc" processManager.url: http://process-manager:3000 ``` -------------------------------- ### Sample directory path example Source: https://help.accusoft.com/RasterMaster/v20.21/docs/java-samples Example of the directory structure for the SingleConversion sample. ```text C:\me\com\snowbound\samples\convert ``` -------------------------------- ### GET /PCCIS/V1/WorkFile/{fileId}/Info Example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/work-files.html Example GET request to retrieve work file metadata, including the required Accusoft-Affinity-Token header, and the successful JSON response. The response contains fileId, fileExtension, and affinityToken. ```http GET prizmdoc_server_base_url/PCCIS/V1/WorkFile/Xe6zv3dH0kVSzLuaNhd32A/Info Accusoft-Affinity-Token: ejN9/kXEYOuken4Pb9ic9hqJK45XIad9LQNgCgQ+BkM= ``` ```http HTTP/1.1 200 OK Content-Type: application/json { "fileId": "Xe6zv3dH0kVSzLuaNhd32A", "fileExtension": "pdf", "affinityToken": "ejN9/kXEYOuken4Pb9ic9hqJK45XIad9LQNgCgQ+BkM=" } ``` -------------------------------- ### GET FormInfo response example Source: https://help.accusoft.com/PrizmDoc/latest/HTML/form-extractors.html Example successful response from the GET FormInfo endpoint. The response body is JSON with a formType array indicating the types of form data available; here it shows "acroform". ```http HTTP/1.1 200 OK Content-Type: application/json { "formType": ["acroform"] } ``` -------------------------------- ### Custom Viewer UI Example (simple.html, simple.js, simple.css) Source: https://help.accusoft.com/PrizmDoc/latest/HTML/build-a-custom-user-interface.html The three files that make up the custom viewer UI example: simple.html embeds the ViewerControl and provides the UI buttons and status bar, simple.js creates the viewer and wires up the UI, and simple.css styles the layout. The HTML loads the product resources and jQuery from the Google CDN. The JavaScript uses the PCCViewer.ViewerControl API and waits for the ViewerReady event before enabling buttons and attaching event handlers. The CSS defines the viewer wrapper and container dimensions. ```html Custom Viewer UI Example
Page 1 of 1
ViewerControl goes here
``` ```javascript $(document).ready(function() { // Get the element where the viewer will be embedded. var element = document.getElementById("viewerControlContainer"); // Create the options object for the viewer var options = { documentID : "a_valid_document_id", imageHandlerUrl: "my_pas_proxy", icons : viewerCustomizations.icons, language : viewerCustomizations.languages['en-US'], // printTemplate : "..." // include a print template for printing to work }; // Create the viewer control var viewerControl = new PCCViewer.ViewerControl(element, options); // It's best practice to wait for the "ViewerReady" event before calling the viewer API. viewerControl.on("ViewerReady", function() { // Display the page count when the estimated and actual page count are available. viewerControl.on("PageCountReady", displayPageCount); viewerControl.on("EstimatedPageCountReady", displayPageCount); function displayPageCount(ev) { $("#totalPages").html(ev.pageCount); } // Display the current page number when the page changes. viewerControl.on("PageChanged", function(ev) { $("#currentPage").html(ev.pageNumber); }); // It's safe to enable the UI buttons during the ViewerReady event $(".viewerButton").prop("disabled", false); // ...and then hookup the UI buttons $("#nextPage").click(function() { viewerControl.changeToNextPage(); }); $("#prevPage").click(function() { viewerControl.changeToPrevPage(); }); $("#zoomOut").click(function() { viewerControl.zoomOut(1.25); // Zoom out 1.25x }); $("#zoomIn").click(function() { viewerControl.zoomIn(1.25); // Zoom in 1.25x }); }); }); ``` ```css .viewerWrapper { width: 600px; height: 600px; position: relative; border: 1px solid #aaa; background: #ddd; } #viewerControlContainer { position: absolute; top: 40px; bottom: 0px; left: 0px; right: 0px; } .floatRight { float: right } ``` -------------------------------- ### Create Maven project with maven-archetype-quickstart Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/create-your-first-project.html Run this Maven command to generate a new Java project. The command uses the maven-archetype-quickstart archetype version 1.4 and is executed from the command line. ```bash mvn -B archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 ``` -------------------------------- ### GET /info Source: https://help.accusoft.com/PrizmDoc/latest/HTML/health.html A request to get information about the service, including the PAS version and the client installer version. ```APIDOC ## GET /info ### Description A request to get information about the service. Returns the PAS version and the client installer version. ### Method GET ### Endpoint /info ### Request Example ``` GET http://localhost:3000/info ``` ### Response #### Success Response (200) ``` HTTP/1.1 200 OK Content-Type: application/json { "version": "X.X.XXXX.XXXX", "clientInstallerVersion": "X.X.X.XXXX" } ``` Where `version` is the PAS version and `clientInstallerVersion` is the version of the installer used to install the PrizmDoc Client. ### Error Responses There are no error states for this request. If the request times out or the connection is refused, then the service is not running or reachable. ``` -------------------------------- ### SoftwareAgent Usage Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.SimplifiedMetadata~ImageGear.Formats.XMP.MediaManagement.ImGearXMPResourceEvent~SoftwareAgent.html Example showing how to get and set the SoftwareAgent property in Visual Basic. ```Visual Basic 'Usage   Dim instance As ImGearXMPResourceEvent Dim value As ImGearXMPString   instance.SoftwareAgent = value   value = instance.SoftwareAgent ``` -------------------------------- ### Build and Run the App with Maven Source: https://help.accusoft.com/BarcodeXpress/latest/BxJava/create-your-first-project.html Use this command to build the application and execute it with Maven's exec plugin. Run it from the project root directory. ```bash mvn package exec:java ``` -------------------------------- ### Complete TIFF Conversion Example Source: https://help.accusoft.com/PrizmDoc/sdks/server/dotnet/v1/how-to/convert-to-tiff.html Complete example showing how to convert a DOCX file to TIFF and save the result. Includes necessary using statements and async Main pattern. ```csharp using System; using System.IO; using System.Threading.Tasks; using Accusoft.PrizmDocServer; namespace Demos { class Program { static void Main(string[] args) { MainAsync().GetAwaiter().GetResult(); } static async Task MainAsync() { var prizmDocServer = new PrizmDocServerClient(/* your connection info */); // Take a DOCX file and convert it to a TIFF. IEnumerable results = await prizmDocServer.ConvertAsync("project-proposal.docx", DestinationFileFormat.Tiff); // Save the result to "output.tiff". await results.Single().RemoteWorkFile.SaveAsync("output.tiff"); } } } ``` -------------------------------- ### Visual Basic Usage Example Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.SimplifiedMetadata~ImageGear.Formats.XMP.IPTC.ImGearIPTC4XMPCoreMetadata~ProvinceState.html Example showing how to get and set the ProvinceState property in Visual Basic. ```vb 'Usage   Dim instance As ImGearIPTC4XMPCoreMetadata Dim value As ImGearXMPString   instance.ProvinceState = value   value = instance.ProvinceState ``` -------------------------------- ### Visual Basic Usage Example Source: https://help.accusoft.com/ImageGear/latest/ImageGear.Core~ImageGear.Formats.EXIF.ImGearEXIFGPSMetadata~ProcessingMethod.html Visual Basic usage example showing get and set operations. ```vb 'Usage Dim instance As ImGearEXIFGPSMetadata Dim value() As Byte instance.ProcessingMethod = value value = instance.ProcessingMethod ``` -------------------------------- ### C# Example for CreateFromMinMax Source: https://help.accusoft.com/ImageGear-Net/v25.2/Windows/HTML/ImageGear.Formats.Dicom~ImageGear.Formats.DICOM.ImGearVOIWindow~CreateFromMinMax.html C# example that creates a window transform using CreateFromMinMax with values 1024 and 2048. ```C# ImGearVOIWindow window = ImGearVOIWindow.CreateFromMinMax(1024, 2048); ``` -------------------------------- ### Visual Basic (Usage) Initialize(String, Double) syntax Source: https://help.accusoft.com/ImageGear/latest/ImageGear.Formats.Office~ImageGear.Formats.Office.ImGearOffice~Initialize%28String%2CDouble%29.html Visual Basic (Usage) syntax showing how to call the ImGearOffice.Initialize method with a string path and a double startup timeout. ```Visual Basic (Usage) 'Usage   Dim path As String Dim officeStartupTimeout As Double   ImGearOffice.Initialize(path, officeStartupTimeout) ```