Table of contents
API
TOC
Collapse the table of content
Expand the table of content

CustomField class

Nadin Merali|Last Updated: 5/6/2017

inherits members from ClientObject

Contains the properties and methods that are used to create an enterprise custom field.

Syntax

CSOM

class CustomField 

JSOM

PS.CustomField

REST Interface

Supported.

PS.CustomField

http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/CustomFields('{fieldid}')

Members

✓ - Read Support       ✓ʷ - Write Support

Properties

Name.NETJSOMRESTTypeDescription
AppAlternateIdGuidGets the alternate custom field GUID that is specified in an App package for Project Online.
Description✓ʷ✓ʷ✓ʷStringGets or sets the description of the custom field.
EntityTypeEntityTypeGets the type of entity (project, task, or resource) for the custom field.
EntityTypeIdGuidGets the type of entity type id(project, task, or resource) for the custom field.
FieldTypeCustomFieldTypeGets the type of the custom field.
Formula✓ʷ✓ʷ✓ʷStringGets or sets the formula that calculates the value of a custom field.
IdGuidGets the GUID of the custom field.
InternalNameStringGets the internal name of the custom field. Reserved for internal use.
IsEditableInVisibility✓ʷ✓ʷ✓ʷBooleanGets or sets a value that indicates whether the value is editable in project site visibility mode.
IsMultilineText✓ʷ✓ʷ✓ʷBooleanGets or sets a value that indicates whether a text custom field can contain multiple lines.
IsRequired✓ʷ✓ʷ✓ʷBooleanGets or sets a value that indicates whether a value for the custom field is required when the entity (project, resource, or task) is created.
IsWorkflowControlled✓ʷ✓ʷ✓ʷBooleanGets or sets a value that indicates whether the custom field value is controlled by a workflow.
LookupAllowMultiSelect✓ʷ✓ʷ✓ʷBooleanGets a value that indicates whether multiple lookup table values can be set for the custom field.
LookupDefaultValue✓ʷ✓ʷ✓ʷGuidGets or sets the GUID of the default value in a lookup table for a custom field.
LookupEntries✓ʷ✓ʷ✓ʷLookupEntryCollectionGets a collection of valid lookup table entries for this field.
LookupTable✓ʷ✓ʷ✓ʷLookupTableGets or sets the LookupTable object for a text custom field.
LookupTableIdGuidGets or sets the LookupTable Id for a text custom field.
Name✓ʷ✓ʷ✓ʷStringGets or sets the name of the custom field.
RollsDownToAssignments✓ʷ✓ʷ✓ʷBooleanGets or sets a value that indicates whether a custom field is set to automatically become a part of the list of available fields for the Assignment cube dimension.
RollupType✓ʷ✓ʷ✓ʷCustomFieldRollupTypeGets or sets the way that the custom field rolls up to summary tasks.

Methods

Name.NETJSOMRESTReturn TypeDescription
DeleteObject()voidDeletes the custom field object.


Method Details

DeleteObject()

Deletes the custom field object.

Syntax
void DeleteObject()
Parameters

None

Return Value

void

See Also

CustomFieldCollection
CustomFieldCreationInformation

© 2018 Microsoft