ICIClientDataField Interface

The ICIClientDataField interface is used in the User Account Details Template on the Site > Security tab, which is used to specify, for privacy purposes, whether a field is enabled, visible, or is considered personal data, in addition to the field's display name and default value.

Members

  • Property DefaultValue As String

    • Retrieves or modifies a specified data field’s default value,

    HRESULT DefaultValue([out, retval] BSTR *pVal);
HRESULT DefaultValue([in] BSTR val);

    Example (VBScript):

    get email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.DefaultValue = “Default”

    EFT v8 and later

  • Property DisplayName As String

    • Retrieves or modifies a specified data field’s display name.

    HRESULT DisplayName([out, retval] BSTR *pVal);
HRESULT DisplayName([in] BSTR val);

    Example (VBScript):

    set email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.DisplayName = “Name”

    EFT v8 and later

  • Property ID As ClientDataField  read-only

    • Retrieves the specified data field's ID. 

    HRESULT ID([out, retval] ClientDataField *pVal);

    Example (VBScript):

    set email = oSite.GetClientDataField(ClientDataFieldId_Email)
wscript.echo email.ID

    EFT v8 and later

  • Property IsEnabled As Boolean

    • Retrieves or modifies the specified data field’s “is enabled" attribute.

    HRESULT IsEnabled([out, retval] VARIANT_BOOL *pVal);
HRESULT IsEnabled([in] VARIANT_BOOL newVal);

    Example (VBScript):

    get email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.IsEnabled = True

    EFT v8 and later

  • Property IsModifiable As Boolean

    • Retrieves or modifies data field’s “is modifiable” attribute.

    HRESULT IsModifiable([out, retval] VARIANT_BOOL *pVal);
HRESULT IsModifiable([in] VARIANT_BOOL newVal);

    Example (VBScript):

    get email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.IsModifiable = True

    EFT v8 and later

  • Property IsPersonalData As Boolean

    • Retrieves or modifies a specified data field’s personal data attribute.

    HRESULT IsPersonalData([out, retval] VARIANT_BOOL *pVal);
HRESULT IsPersonalData([in] VARIANT_BOOL newVal);

    Example (VBScript):

    get email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.IsPersonalData = True

    EFT v8 and later

  • Property IsVisible As Boolean

    • Retrieves modifies data field’s “is visible” attribute.

    HRESULT IsVisible([out, retval] VARIANT_BOOL *pVal);
HRESULT IsVisible([in] VARIANT_BOOL newVal);

    Example (VBScript):

    get email = oSite.GetClientDataField(ClientDataFieldId_Email)
email.IsEnabled = True

    EFT v8 and later

Dialog Box Equivalents

Site > User Account Details Template