Application.CustomOutlineCodeEditEx method (Project)

Article
09/13/2021

Edits a local outline code custom field definition.

Syntax

expression.CustomOutlineCodeEditEx (FieldID, Level, Sequence, Length, Separator, OnlyLookUpTableCodes, OnlyCompleteCodes, OnlyLeaves, MatchGeneric, RequiredCode, LookupDefault, DefaultValue, SortOrder)

expression An expression that returns an Application object.

Parameters

Name	Required/Optional	Data type	Description
FieldID	Required	PjCustomField	Specifies the custom outline code to edit. Can be one of the non-enterprise PjCustomField constants.
Level	Optional	Long	The level of code mask to edit. The default value is one greater than the highest level currently specified for the field.
Sequence	Optional	PjCustomOutlineCodeSequence	The sequence for the level specified in Level. Can be one of the PjCustomOutlineCodeSequence constants. The default value is pjCustomOutlineCodeNumbers.
Length	Optional	Variant	Specifies the length for a given level. Can be the string "Any" or an integer value from 1 through 255. The default value is "Any".
Separator	Optional	String	The character that separates the level specified in Level from the next. Can be one of ".", "-", "+", or "/". The default value is ".".
OnlyLookUpTableCodes	Optional	Boolean	True if only codes listed in the lookup table can be used; otherwise, False. The default value is False, which allows additional items to be added.
OnlyCompleteCodes	Optional	Boolean	True if only codes with values at all levels of the mask can be used; otherwise, False. The default value is False.
LookupTableLink	Optional	Long	Deprecated in Project and later versions. Local outline codes cannot share lookup tables. Caution Do not use LookupTableLink with the enterprise global or enterprise lookup tables. Data corruption can result.
OnlyLeaves	Optional	Boolean	True if only outline code values without subordinate values can be selected; otherwise, False. The default is False.
MatchGeneric	Optional	Boolean	True if Project uses the outline code in the Resource Substitution Wizard; otherwise, False. The default is False.
RequiredCode	Optional	Boolean	True if the outline code must be present before save is allowed; otherwise, False. The default is False.
LookupDefault	Optional	Boolean	True if the outline code has a default value; otherwise, False. The default is False.
DefaultValue	Optional	String	Specifies the default value of the outline code.
SortOrder	Optional	Long	Specifies whether sorting is ascending, descending, or the lookup table row order. Can be one of the PjListOrder constants. The default is pjListOrderDefault.

Return value

Boolean

Remarks

If only the FieldID argument is specified, the CustomOutlineCodeEditEx method displays the Code Mask Definition dialog box for the specified outline code.

The OnlyLeaves, MatchGeneric, and RequiredCode arguments are available only in Project Professional.

Example

The following example edits an existing Outline Code 1 for tasks, in which the only code mask is "*" for the first level. With default values in the CustomOutlineCodeEditEx method, the first command in the example specifies that the second level uses two-digit codes, sorted by number, and is separated from the third level by the "-" character. The second command specifies that the third level uses a single uppercase letter. It also specifies that only codes that contain all three levels can be used.

To use the example, the original Outline Code 1 contains the characters "oc1" in the first level. After running the code, the code mask is "*.11-A". A user can edit the lookup table and add, for example, "23" in the level under "oc1" and "X" in the third level. When setting the value of Outline Code 1, the user can choose oc1.23-X, but can not choose oc1.23.

Sub EditCustOutlineCode() 
    CustomOutlineCodeEditEx pjCustomTaskOutlineCode1, Length:=2, _ 
        Separator:="-" 
    CustomOutlineCodeEditEx pjCustomTaskOutlineCode1, Length:=1, _ 
        Sequence:=pjCustomOutlineCodeUppercaseLetters, OnlyCompleteCodes:=True 
End Sub

In the following example, the task Outline Code 3 contains the lookup table values "a", "b", and "c". Running the example changes the order the user sees when setting the value, to "c", "b", and "a", with the default value "b".

Sub ChangeOCDefaults() 
    CustomOutlineCodeEditEx FieldID:=pjCustomTaskOutlineCode3, SortOrder:=pjListOrderDescending 
     
    CustomOutlineCodeEditEx FieldID:=pjCustomTaskOutlineCode3, LookupDefault:=True, DefaultValue:="b" 
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