The JS_DocFileDataField class represents the special comment field at the DocFile. More...

Public Member Functions
String	getLastError ()
	If you call a method at a DocFileDataField object and an error occurred, you can get the error description with this function. More...

String	getValue ()
	Get the comment as String. More...

boolean	setValue (String value)
	Set the comment as String. More...

Public Attributes
String	hash
	Hash value of the last field value. More...

String	name
	Name of the field. More...

String	readAccess
	Access-right to read the field. More...

String	writeAccess
	Access-right to write the field. More...

Detailed Description

The JS_DocFileDataField class represents the special comment field at the DocFile.

Since: DOCUMENTS 5.0d

Member Function Documentation

◆ getLastError()

String DocFileDataField::getLastError ( )

If you call a method at a DocFileDataField object and an error occurred, you can get the error description with this function.

Returns: Text of the last error as String

Since: DOCUMENTS 5.0d

◆ getValue()

String DocFileDataField::getValue ( )

Get the comment as String.

Returns: String containing the comment

Since: DOCUMENTS 5.0d

◆ setValue()

boolean DocFileDataField::setValue ( String value )

Set the comment as String.

Parameters

value String containing the new comment

Returns: true if successful, false in case of any error

Since: DOCUMENTS 5.0d

Member Data Documentation

◆ hash

String DocFileDataField::hash

Hash value of the last field value.

Returns: String with sha256 hash.

Since: DOCUMENTS 5.0d

◆ name

String DocFileDataField::name

Name of the field.

Returns: String with name.

Since: DOCUMENTS 5.0d

◆ readAccess

String DocFileDataField::readAccess

Access-right to read the field.

Returns: true or false.

Since: DOCUMENTS 5.0d

◆ writeAccess

String DocFileDataField::writeAccess

Access-right to write the field.

Returns: true or false.

Since: DOCUMENTS 5.0d

Public Member Functions

Public Attributes