Task.GetField method (Project)

Article
01/19/2022

Returns the value of the specified task custom field.

Syntax

expression. GetField( _FieldID_ )

expression A variable that represents a Task object.

Parameters

Name	Required/Optional	Data type	Description
FieldID	Required	Long	For a local custom field, can be one of the PjField constants for task custom fields. For an enterprise custom field, use the FieldNameToFieldConstant method to get the FieldID.

Return value

String

Remarks

If the task custom field is an estimated duration, the returned value also includes the character that indicates an estimated value.

You can access project custom fields through the ProjectSummaryTask property.

Example

The following example uses the SetField method and the GetField method together with the FieldNameToFieldConstant method and the FieldConstantToFieldName method:

To use the example, use Project Web App to create an enterprise project text custom field named TestEntProjText.
Restart Project Professional with a Project Server profile so that it includes the new custom field.
Create a project with some value for the TestEntProjText field, by using the Project Information dialog box.
The TestEnterpriseProjectCF macro uses the FieldNameToFieldConstant method to find the projectField number, for example, 190873618.
The macro shows the number and text value in a message box, by using the GetField method.
The macro gets the field name by using the FieldConstantToFieldName method, sets a new value by using the SetField method, and then shows the field name and new value in another message box.

Sub TestEnterpriseProjectCF() 
    Dim projectField As Long 
    Dim projectFieldName As String 
    Dim message As String 
 
    projectField = FieldNameToFieldConstant("TestEntProjText", pjProject) 
 
    ' Show the enterprise project field number and old value. 
    message = "Enterprise project field number: " & projectField & vbCrLf 
    MsgBox message & ActiveProject.ProjectSummaryTask.GetField(projectField) 
 
    ActiveProject.ProjectSummaryTask.SetField FieldID:=projectField, Value:="This is a new value." 
 
    ' For a demonstration, get the field name from the field number, and verify the new value. 
    projectFieldName = FieldConstantToFieldName(projectField) 
    message = "New value for field: " & projectFieldName & vbCrLf 
    MsgBox message & ActiveProject.ProjectSummaryTask.GetField(projectField) 
End Sub

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.

Share via