Outline Codes in a Project

Custom outline codes are tags you define for tasks or resources that provide a project structure that is different from WBS codes or outline numbers. Aspose.Tasks for C++ lets you retrieve these outline codes and their properties, such as Alias, AllLevelsRequired, Enterprise, EnterpriseOutlineCodeAlias, FieldId, FieldName, PhoneticAlias, GUID, Masks and Values.

Reading Outline Codes

The Project class exposes OutlineCodes which is a collection of OutlineCodeDefinition items. The OutlineCodeDefinition provides all the detail as shown in the following sample code.

The following lines of code retrieve a project’s outline code information.

System::SharedPtr<Project> project = System::MakeObject<Project>(dataDir + u"OutlineCodes.mpp");
    
    
{
    auto ocd_enumerator = (project->get_OutlineCodes())->GetEnumerator();
    decltype(ocd_enumerator->get_Current()) ocd;
    while (ocd_enumerator->MoveNext() && (ocd = ocd_enumerator->get_Current(), true))
    {
        System::Console::WriteLine(System::String(u"Alias = ") + ocd->get_Alias());
        if (ocd->get_AllLevelsRequired())
        {
            System::Console::WriteLine(u"It contains property: must have all levels");
        }
        else
        {
            System::Console::WriteLine(u"It does not contain property: must have all levels");
        }
        if (ocd->get_Enterprise())
        {
            System::Console::WriteLine(u"It is an enterprise custom outline code.");
        }
        else
        {
            System::Console::WriteLine(u"It is not an enterprise custom outline code.");
        }
        
        System::Console::WriteLine(System::String(u"Reference to another custom field for which this outline code definition is an alias is = ") + ocd->get_EnterpriseOutlineCodeAlias());
        System::Console::WriteLine(System::String(u"Field Id = ") + ocd->get_FieldId());
        System::Console::WriteLine(System::String(u"Field Name = ") + ocd->get_FieldName());
        System::Console::WriteLine(System::String(u"Phonetic Alias = ") + ocd->get_PhoneticAlias());
        System::Console::WriteLine(System::String(u"Guid = ") + ocd->get_Guid());
        
        // Display outline code masks
        
        {
            auto outlineMask_enumerator = (ocd->get_Masks())->GetEnumerator();
            decltype(outlineMask_enumerator->get_Current()) outlineMask;
            while (outlineMask_enumerator->MoveNext() && (outlineMask = outlineMask_enumerator->get_Current(), true))
            {
                System::Console::WriteLine(System::String(u"Level of a mask = ") + outlineMask->get_Level());
                System::Console::WriteLine(System::String(u"Mask = ") + System::ObjectExt::ToString(outlineMask));
            }
        }
        
        // Display out line code values
        
        {
            auto outlineMask1_enumerator = (ocd->get_Values())->GetEnumerator();
            decltype(outlineMask1_enumerator->get_Current()) outlineMask1;
            while (outlineMask1_enumerator->MoveNext() && (outlineMask1 = outlineMask1_enumerator->get_Current(), true))
            {
                System::Console::WriteLine(System::String(u"Description of outline value = ") + outlineMask1->get_Description());
                System::Console::WriteLine(System::String(u"Value Id = ") + outlineMask1->get_ValueId());
                System::Console::WriteLine(System::String(u"Value = ") + outlineMask1->get_Value());
                System::Console::WriteLine(System::String(u"Type = ") + System::ObjectExt::ToString(outlineMask1->get_Type()));
            }
        }
    }
}

Check Outline Code Id Uniqueness

While working with OutlineCode, Aspose.Tasks shall check the uniqueness of the Outline Code Id and duplicate Ids will be replaced with unique values.

System::SharedPtr<Project> project = System::MakeObject<Project>(dataDir + u"OutlineValues2010.mpp");
    
System::SharedPtr<OutlineCodeDefinition> textOutline = System::MakeObject<OutlineCodeDefinition>();
textOutline->set_FieldId(System::Convert::ToString((int)Aspose::Tasks::ExtendedAttributeTask::OutlineCode7));
textOutline->set_Alias(u"My Outline Code");
    
project->get_OutlineCodes()->Add(textOutline);
    
System::SharedPtr<OutlineMask> mask = System::MakeObject<OutlineMask>();
mask->set_Type(Aspose::Tasks::MaskType::Characters);
textOutline->get_Masks()->Add(mask);
    
System::SharedPtr<OutlineValue> textValue = System::MakeObject<OutlineValue>();
textValue->set_Value(u"Text value 1");
textValue->set_ValueId(1);
textValue->set_Type(Aspose::Tasks::OutlineValueType::Text);
textValue->set_Description(u"Text value descr 1");
textOutline->get_Values()->Add(textValue);
    
project->Save(dataDir + u"MultipleOutlineValues.mpp", Aspose::Tasks::Saving::SaveFileFormat::MPP);