1. Home
  2. SDK for .NET 3.22.0
  3. Stamp samples
  1.  

SDK for .NET 3.22.0
Requirements
Sample client
Basic concepts
Activity samples
Auth samples
Autocad samples
Bookmark samples
Conversion samples
Dashboard samples
Document samples
FilePlan samples
Folder samples
Import samples
Mail samples
Node samples
Note samples
Notification samples
PDF samples
Plugin samples
Property samples
PropertyGroup samples
Record samples
Relation samples
Repository samples
Report samples
Stamp samples
Search samples
Shard samples
Task samples
UserConfig samples
Wizard samples
Workflow samples

Stamp samples

Basics

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then should login using the method "login". You can access the "login" method from webservice object "ws" as is shown below:

ws.login(user, password);

Once you are logged with the webservices the session is keep in the webservice Object. Then you can use the other API method

At this point you can use all the Stamp methods from "stamp" class as is shown below:

ws.stamp.getAllStamps();

Methods

getAllStamps

Description:

MethodReturn valuesDescription

getAllStamps()

List<StampItem>

Returns a list of the stamp items

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                List<StampItem> stamps = ws.stamp.getAllStamps();
                foreach(StampItem stamItem in stamps)
                {
                     System.Console.WriteLine(stamItem.name);
                }
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

testGetStampTextByPk

Description:

MethodReturn valuesDescription

getStampTextByPk(long id, String uuid)

StampText

Return the stamp of type Text by Id.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = 1;
                List<StampItem> stamps = ws.stamp.getStampTextByPk(id, document.uuid);                
                System.Console.WriteLine(stamp.name);
                System.Console.WriteLine(stamp.description);                
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

getStampImageByPk

Description:

MethodReturn valuesDescription

getStampImageByPk(long id, String uuid)

StampImage

Return the stamp of type image by Id.

Example:

using System; 
using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = 1;
                List<StampItem> stamps = ws.stamp.getStampImageByPk(id, document.uuid);
                System.Console.WriteLine(stampImage.name);
                System.Console.WriteLine(stampImage.description);               
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

getStampBarcodeByPk

Description:

MethodReturn valuesDescription

getStampBarcodeByPk(long id, String uuid)

StampBarcode

Return the stamp of type barcode by Id.

 

Example:

using System;
using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = 1;
                StampBarcode stampBarcode = ws.stamp.getStampBarcodeByPk(id, "6330d2a0-529f-4c14-baa1-ce6a92004e01");
                System.Console.WriteLine(stampBarcode.name);
                System.Console.WriteLine(stampBarcode.description);
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

calculateStampCoordinates

Description:

MethodReturn valuesDescription

calculateStampCoordinates(long imgToStampWidth, long imgToStampHeight, long floatingDivWidth,
long floatingDivHeight, String exprX, String exprY, String stampType, String stampAlign)

StampCoordinates

Return the calculated stamp coordinates.

In Expr. X and Expr. Y input fields you can put more than a simple number. Currently, the following macros are defined:

  • IMAGE_WIDTH
  • IMAGE_HEIGHT
  • PAGE_WIDTH
  • PAGE_HEIGHT
  • PAGE_CENTER
  • PAGE_MIDDLE

So to center a stamp in the page you can use:

Expr. X

PAGE_CENTER
Expr. Y

PAGE_MIDDLE

 The parameter stampAlign.

Available values:

  • text
  • image

The parameter stampAlign is the Text Align

Available values:

  • left
  • center
  • right

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long floatingDivWidth = 250;
                long floatingDivHeight = 300;
                string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
                string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
                string stampType = "text";
                string stampAlign = "center";
                StampCoordinates stampCoordinates = ws.stamp.calculateStampCoordinates(imgToStampWidth, imgToStampHeight,
                floatingDivWidth, floatingDivHeight, exprX, exprY, stampType, stampAlign); 
                System.Console.WriteLine("X = " + stampCoordinates.x + ", Y = " + stampCoordinates.y);             
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

calculateStampExpressions

Description:

MethodReturn valuesDescription

calculateStampExpressions(long imgToStampWidth, long imgToStampHeight, long posX, long posY)

StampExpressions

Return the calculated stamp expressions for X and Y.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long posX = 10;
                long posY = 50;
                StampExpressions stampExpressions = ws.stamp.calculateStampExpressions(imgToStampWidth, imgToStampHeight, posX, posY);
                System.Console.WriteLine("X = " + stampExpressions.exprX + ", Y = " + stampExpressions.exprY);              
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

stampText

Description:

MethodReturn valuesDescription

stampText(String  uuid, long id)

void

Stamp text in a document.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = "1";
                ws.stamp.stampText("babe24df-c443-49a5-9453-39dfc9b27924", id);             
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

stampImage

Description:

MethodReturn valuesDescription

stampImage(String uuid, long id)

void

Stamp image in a document.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = "3";
                ws.stamp.stampImage("babe24df-c443-49a5-9453-39dfc9b27924", id);             
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

stampBarcode

Description:

MethodReturn valuesDescription

stampBarcode(String uuid, long id)

void

Stamp barcode in a document.

 

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long id = 1;
                ws.stamp.stampBarcode("6330d2a0-529f-4c14-baa1-ce6a92004e01", id);            
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

stampImageManually

Description:

MethodReturn valuesDescription

stampImageCustom(String uuid, long id, String exprX, String exprY, String range, String personalStampUuid)

void

Stamp in a document with a custom image.

The id is the id of an image stamp which is created in the administrator.

The exprX is the expression to set the position in X coordinates.

The exprY is the expression to set the position in Y coordinates.

The personalStampUuid must be a valid document UUID. The document must be an image ( jpg or png ).

 

In Expr. X and Expr. Y input fields you can put more than a simple number. Currently, the following macros are defined:

  • IMAGE_WIDTH
  • IMAGE_HEIGHT
  • PAGE_WIDTH
  • PAGE_HEIGHT
  • PAGE_CENTER
  • PAGE_MIDDLE

So to center a stamp in the page you can use:

Expr. X

PAGE_CENTER
Expr. Y

PAGE_MIDDLE

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long stampId = "1";
                string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
                string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
                ws.stamp.stampImageCustom("babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "", "928de61e-6ceb-4f94-bf20-9ba2405c5cee");           
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

stampImageCustom

Description:

MethodReturn valuesDescription

stampImageCustom(String uuid, long id, String exprX, String exprY, String range, double ratio, FileStream fs)

void

Stamp in a document with a custom image.

The id is the id of an image stamp which is created in the administrator.

The exprX is the expression to set the position in X coordinates.

The exprY is the expression to set the position in Y coordinates.

In Expr. X and Expr. Y input fields you can put more than a simple number. Currently, the following macros are defined:

  • IMAGE_WIDTH
  • IMAGE_HEIGHT
  • PAGE_WIDTH
  • PAGE_HEIGHT
  • PAGE_CENTER
  • PAGE_MIDDLE

So to center a stamp in the page you can use:

Expr. X

PAGE_CENTER
Expr. Y

PAGE_MIDDLE

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
          String host = "http://localhost:8080/openkm"; 
          String username = "okmAdmin"; 
          String password = "admin"; 
          OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

          try 
          { 
              ws.login(user, password); 
              long stampId = "1";
              string exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";
              string exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";
              FileStream fsimg = new FileStream(@"C:\test.jpg", FileMode.Open, FileAccess.Read); 
              ws.stamp.stampImageCustom("babe24df-c443-49a5-9453-39dfc9b27924", stampId, exprX, exprY, "", 0, fsimg);
              fsimg.Close();
          } 
          catch (Exception e) 
          { 
              System.Console.WriteLine(e.ToString()); 
          }
       } 
    }
}

calculateFlyImageDimensions

Description:

MethodReturn valuesDescription

calculateFlyImageDimensions(String uuid, long imgToStampWidth, long imgToStampHeight,
            long floatingImageWidth, long floatingImageHeight, int pageNumber)

StampImageSize

Return the calculated image to stamp height and width size.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                // Parameters
                long imgToStampWidth = 100;
                long imgToStampHeight = 100;
                long floatingImageWidth = 300;
                long floatingImageHeight = 300;
                int pageNumber = 2;

                StampImageSize stampImageSize = ws.stamp.calculateFlyImageDimensions("babe24df-c443-49a5-9453-39dfc9b27924", imgToStampWidth, imgToStampHeight, 
                       floatingImageWidth, floatingImageHeight, pageNumber);
                System.Console.WriteLine(stampImageSize);          
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

getPersonalStamps

Description:

MethodReturn valuesDescription

getPersonalStamps()

 List<Document>

Returns a list of personal seals.

Return a list of documents of type image ( jpg or png ) from /okm:templates/ userId/stamps

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                List<Document> docs = ws.stamp.getPersonalStamps();
                foreach (Document doc in docs)
                {
                     System.Console.WriteLine(doc.toString());
                }   
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

getPersonalStampImage

Description:

MethodReturn valuesDescription

getPersonalStampImage(String uuid, long id)

 StampPersonalImage

Return the personal seal processed.

When stamping a document with an image, the image also can have a text layer.

This method processes the image and returns an image with the text layer.

The uuid must be an uuid returned by the method getPersonalStamps.

Example:

using System; using System.Collections.Generic;
using System.Text; 
using com.openkm.sdk4csharp; 
using com.openkm.sdk4csharp.bean; 

namespace OKMRest 
{ 
    public class Program 
    { 
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";  
            String username = "okmAdmin"; 
            String password = "admin"; 
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host); 

            try 
            { 
                ws.login(user, password);   
                long stampId = 1;
                StampPersonalImage stampPersonalImage = ws.stamp.getPersonalStampImage("928de61e-6ceb-4f94-bf20-9ba2405c5cee", stampId);
                System.Console.WriteLine(stampPersonalImage.ToString());  
            } 
            catch (Exception e) 
            { 
                System.Console.WriteLine(e.ToString()); 
            
            }
       } 
   }
}

© OpenKM kcenter v.1.0.0 (build: d51a7b0). All Rights Reserved. Documentation license