UserData Property

Summary

The user-defined data associated with this document.

Syntax

C++/CLI

Java

Python

public object UserData {get; set;}

public:  
   property Object^ UserData 
   { 
      Object^ get() 
      void set(Object^ value) 
   }

public Object getUserData() 
public void setUserData(Object value)

UserData # get and set (LEADDocument)

Property Value

Any object that can be used as the user-defined data associated with this document. Default value is null.

Remarks

UserData is not used by the LEADDocument but by the user to associate an external resource with the LEADDocument.

If LEADDocument uses the cache, then UserData will be saved and re-loaded from the cache as well. This is performed using the value set DataSerializationMode. So for primitives values, nothing more needs to be done. If UserData was set to a complex user-defined object, then the class must contain the necessary attributes or implement the necessary interfaces used with the current serialization mode. Refer to CacheSerializationMode for more information.

Requirements

Target Platforms