←Select platform

UserData Property

Summary

The user-defined data associated with this document.

Syntax

Java

C++

public object UserData { get; set; }

Public Property UserData() As Object 
   Get 
   Set

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

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

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 Document, the user can set any application value to associated this document object with an external resource.

If this document 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

Reference

Document Class

Document Members

Leadtools.Documents Namespace

Help Version 19.0.2017.10.27