com.mindoo.remote.api.symphony.document
Interface IRemoteUserField

All Superinterfaces:

IRemoteField

public interface IRemoteUserField
extends IRemoteField

This class is a subclass of the Field class and represents a user field in a document.

Creation and access

• To get a user field in a document, use the itemByType method in the Fields class.
• To create a user field, use the addUserField method in the Fields class.

Usage
The value of a user field can be a string value or a double value. The Content property is used to set the string value for a user field. The Value property is used to set the double value for a user field. The value of the Content property and Value property can overwrite each other's value.

• When you set the value of the Content property, the value of the Value property is the numeric conversion value of the Content property's value.
• When you set the value of the Value property, the value of the Content property is the string conversion value of the Value property's value.

For example, if you set the Content property's value to Test, the Value property's value is 0; if you set the Value property's value to 26.7, the Content property's value is 26.7.

Method Summary

java.lang.String	getName() This property returns the name of a user field.
double	getValue() This property returns or sets the value of a user field.
boolean	isVisible() This property returns or sets whether the field is visible.
void	setContent(java.lang.String content) This property returns or sets the content of a user field.
void	setValue(double value) This property returns or sets the value of a user field.
void	setVisible(boolean visible) This property returns or sets whether the field is visible.

Methods inherited from interface com.mindoo.remote.api.symphony.document.IRemoteField

getContent, getRange, getType, remove

Method Detail

setContent

void setContent(java.lang.String content)
                throws RemoteEclipseAPIException

This property returns or sets the content of a user field.

Parameters:

content - content

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns the name of a user field.

Returns:

name

Throws:

RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException

This property returns or sets the value of a user field.

Returns:

value

Throws:

RemoteEclipseAPIException

setValue

void setValue(double value)
              throws RemoteEclipseAPIException

This property returns or sets the value of a user field.

Parameters:

value - value

Throws:

RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

This property returns or sets whether the field is visible.

Returns:

true, when the field is visible.

Throws:

RemoteEclipseAPIException

setVisible

void setVisible(boolean visible)
                throws RemoteEclipseAPIException

This property returns or sets whether the field is visible.

Parameters:

visible - true, when the field is visible.

Throws:

RemoteEclipseAPIException