Aspose.Tasks for C++
Aspose::Tasks::ExtendedAttributeDefinition Class Reference

Represents an extended attribute definition associated with a project. More...

#include <ExtendedAttributeDefinition.h>

Inherits System::Object.

Public Member Functions

System::String get_FieldId () const
 Gets corresponds to the project id of a custom field. Use string representation of a constant from Aspose::Tasks::ExtendedAttributeTask class to specify FieldId property. More...
 
void set_FieldId (const System::String &value)
 Sets corresponds to the project id of a custom field. Use string representation of a constant from Aspose::Tasks::ExtendedAttributeTask class to specify FieldId property. More...
 
System::String get_FieldName () const
 Gets the name of a custom field. More...
 
CustomFieldType get_CfType ()
 Gets the type of a custom field. More...
 
System::String get_Guid () const
 Gets the Guid of a custom field. More...
 
void set_Guid (const System::String &value)
 Sets the Guid of a custom field. More...
 
Aspose::Tasks::ElementType get_ElementType ()
 Gets the extended attribute is associated with a task, a resource or an assignment. More...
 
void set_ElementType (Aspose::Tasks::ElementType value)
 Sets the extended attribute is associated with a task, a resource or an assignment. More...
 
int32_t get_MaxMultiValues () const
 Gets the maximum number of values you can set in a pick list. More...
 
void set_MaxMultiValues (int32_t value)
 Sets the maximum number of values you can set in a pick list. More...
 
bool get_UserDef () const
 Gets a value indicating whether a custom field is user defined. More...
 
void set_UserDef (bool value)
 Sets a value indicating whether a custom field is user defined. More...
 
System::String get_Alias () const
 Gets the alias of a custom field. More...
 
void set_Alias (const System::String &value)
 Sets the alias of a custom field. More...
 
System::String get_SecondaryPid () const
 Gets the secondary PID of a custom field. More...
 
void set_SecondaryPid (const System::String &value)
 Sets the secondary PID of a custom field. More...
 
bool get_AutoRollDown () const
 Gets a value indicating whether an automatic roll down to assignments is enabled. More...
 
void set_AutoRollDown (bool value)
 Sets a value indicating whether an automatic roll down to assignments is enabled. More...
 
System::String get_DefaultGuid () const
 Gets the Guid of the default lookup table entry. More...
 
void set_DefaultGuid (const System::String &value)
 Sets the Guid of the default lookup table entry. More...
 
System::String get_LookupUid () const
 Gets a Guid of the lookup table associated with a custom field. More...
 
System::String get_PhoneticsAlias () const
 Gets the phonetic pronunciation of the alias of a custom field. More...
 
void set_PhoneticsAlias (const System::String &value)
 Sets the phonetic pronunciation of the alias of a custom field. More...
 
Aspose::Tasks::RollupType get_RollupType () const
 Gets the way rollups are calculated. More...
 
void set_RollupType (Aspose::Tasks::RollupType value)
 Sets the way rollups are calculated. More...
 
Aspose::Tasks::CalculationType get_CalculationType () const
 Gets the type of calculation of the custom attribute's value. More...
 
void set_CalculationType (Aspose::Tasks::CalculationType value)
 Sets the type of calculation of the custom attribute's value. More...
 
Aspose::Tasks::SummaryRowsCalculationType get_SummaryRowsCalculationType () const
 Gets the type of calculation of the custom attribute's value for summary rows. More...
 
void set_SummaryRowsCalculationType (Aspose::Tasks::SummaryRowsCalculationType value)
 Sets the type of calculation of the custom attribute's value for summary rows. More...
 
System::String get_Formula ()
 Gets the formula that Microsoft Project uses to populate a custom task field. More...
 
void set_Formula (const System::String &value)
 Sets the formula that Microsoft Project uses to populate a custom task field. More...
 
bool get_RestrictValues () const
 Gets a value indicating whether the custom field values are restricted to values in the ValueList. More...
 
void set_RestrictValues (bool value)
 Sets a value indicating whether the custom field values are restricted to values in the ValueList. More...
 
int32_t get_ValuelistSortOrder () const
 Gets the way value lists are sorted. Values are: 0=Descending, 1=Ascending. More...
 
void set_ValuelistSortOrder (int32_t value)
 Sets the way value lists are sorted. Values are: 0=Descending, 1=Ascending. More...
 
bool get_AppendNewValues () const
 Gets a value indicating whether new values added to a project are automatically added to the list. More...
 
void set_AppendNewValues (bool value)
 Sets a value indicating whether new values added to a project are automatically added to the list. More...
 
System::String get_Default () const
 Gets the default value in the list. More...
 
void set_Default (const System::String &value)
 Sets the default value in the list. More...
 
const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Value > > > & get_ValueList () const
 Gets the List<Value> ValueList. More...
 
System::String get_SecondaryGuid () const
 Gets the secondary guid of extended attribute. More...
 
void set_SecondaryGuid (const System::String &value)
 Sets the secondary guid of extended attribute. More...
 
System::SharedPtr< Projectget_ParentProject () const
 Gets the parent project for the ExtendedAttributeDefinition instance. More...
 
void AddLookupValue (const System::SharedPtr< Value > &value)
 Adds a value to the internal lookup list. This is a preferable way for manipulations with the ValueList. More...
 
void RemoveLookupValue (const System::SharedPtr< Value > &value)
 Removes a value from the internal lookup list. This is a preferable way for manipulations with the ValueList. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute ()
 Creates a new extended attribute with the field ID which equals to this object's field ID value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (const System::String &textValue)
 Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified text value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (System::Decimal numericValue)
 Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified numeric value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (System::DateTime dateTimeValue)
 Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified date value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (Duration durationValue)
 Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified duration value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (bool flagValue)
 Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified flag value. More...
 
System::SharedPtr< ExtendedAttributeCreateExtendedAttribute (const System::SharedPtr< Value > &lookupValue)
 Creates new extended attribute linked with specified Value item. More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Returns a flag indicating whether this instance is equal to the specified object. More...
 
int32_t GetHashCode () const override
 Returns a hash code for the instance of the ExtendedAttributeDefinition class. More...
 

Static Public Member Functions

static System::SharedPtr< ExtendedAttributeDefinitionCreateTaskDefinition (CustomFieldType customFieldType, ExtendedAttributeTask fieldId, const System::String &alias)
 Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Tasks only. You are required to specify customFieldType , fieldId and alias when calling this method. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateTaskDefinition (ExtendedAttributeTask fieldId, const System::String &alias)
 Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Tasks only. You are required to specify fieldId and alias when calling this method. The field type is inferred from field id. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateResourceDefinition (CustomFieldType customFieldType, ExtendedAttributeResource fieldId, const System::String &alias)
 Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Resource only. You are required to specify customFieldType , fieldId and alias when call this method. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateResourceDefinition (ExtendedAttributeResource fieldId, const System::String &alias)
 Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Resource only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateLookupTaskDefinition (ExtendedAttributeTask fieldId, const System::String &alias)
 Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Tasks only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateLookupTaskDefinition (CustomFieldType customFieldType, ExtendedAttributeTask fieldId, const System::String &alias)
 Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Tasks only. You are required to specify customFieldType , fieldId and alias when call this method. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateLookupResourceDefinition (ExtendedAttributeResource fieldId, const System::String &alias)
 Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Resources only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id. More...
 
static System::SharedPtr< ExtendedAttributeDefinitionCreateLookupResourceDefinition (CustomFieldType customFieldType, ExtendedAttributeResource fieldId, const System::String &alias)
 Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Resources only. You are required to specify customFieldType , fieldId and alias when call this method. More...
 

Detailed Description

Represents an extended attribute definition associated with a project.

Member Function Documentation

◆ AddLookupValue()

void Aspose::Tasks::ExtendedAttributeDefinition::AddLookupValue ( const System::SharedPtr< Value > &  value)

Adds a value to the internal lookup list. This is a preferable way for manipulations with the ValueList.

Parameters
valueValue to add into lookup.

This method works only for ExtendedAttributeDefinition instances which have CalculationType equals to Tasks::CalculationType::Lookup.

Use this code to add new Value to lookup list:

taskTextAttr.AddLookupValue(new Value { Id = 1, Val = "Text value 1", Description = "Text value description 1" });

◆ CreateExtendedAttribute() [1/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( )

Creates a new extended attribute with the field ID which equals to this object's field ID value.

Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.

◆ CreateExtendedAttribute() [2/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( bool  flagValue)

Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified flag value.

Parameters
flagValueThe specified flag value.
Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.
Exceptions
InvalidOperationExceptionIf current CfType is not 'Flag'

◆ CreateExtendedAttribute() [3/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( const System::SharedPtr< Value > &  lookupValue)

Creates new extended attribute linked with specified Value item.

Parameters
lookupValueThe specified Value item.

lookupValue should be previously added to the ExtendedAttributeDefinition using AddLookupValue method.

Returns
returns created instance of the ExtendedAttribute class linked with specified Value item.

Use this code to create new ExtendedAttribute using specific value:

taskTextAttr.AddLookupValue(value1);
taskTextAttr.AddLookupValue(value2);
var extendedAttribute = taskTextAttr.CreateExtendedAttribute(value2);

◆ CreateExtendedAttribute() [4/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( const System::String &  textValue)

Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified text value.

Parameters
textValueThe specified text value.
Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.
Exceptions
InvalidOperationExceptionIf current CfType is not 'Text'

◆ CreateExtendedAttribute() [5/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( Duration  durationValue)

Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified duration value.

Parameters
durationValueThe specified duration value.
Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.
Exceptions
InvalidOperationExceptionIf current CfType is not 'Duration'

◆ CreateExtendedAttribute() [6/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( System::DateTime  dateTimeValue)

Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified date value.

Parameters
dateTimeValueThe specified date time value.
Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.
Exceptions
InvalidOperationExceptionIf current CfType is not 'Date', 'Start' or 'Finish'

◆ CreateExtendedAttribute() [7/7]

System::SharedPtr<ExtendedAttribute> Aspose::Tasks::ExtendedAttributeDefinition::CreateExtendedAttribute ( System::Decimal  numericValue)

Creates a new extended attribute with the field ID which equals to this object's field ID value and the specified numeric value.

Parameters
numericValueThe specified numeric value.
Returns
returns created instance of the ExtendedAttribute class with the fieldID which equals to this object's fieldID value.
Exceptions
InvalidOperationExceptionIf current CfType is not 'Number' or 'Cost'

◆ CreateLookupResourceDefinition() [1/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateLookupResourceDefinition ( CustomFieldType  customFieldType,
ExtendedAttributeResource  fieldId,
const System::String &  alias 
)
static

Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Resources only. You are required to specify customFieldType , fieldId and alias when call this method.

Parameters
customFieldTypeThe specified CustomFieldType type.
fieldIdThe specified ExtendedAttributeResource field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified customFieldType , fieldId and alias .

Use this example to create a custom field definition for a resource with lookup and then fill it with text values:

var resourceTextAttr = ExtendedAttributeDefinition.CreateLookupResourceDefinition(CustomFieldType.Text, ExtendedAttributeResource.Text27, "My custom field");
resourceTextAttr.AddLookupValue(new Value { Id = 1, Val = "Text value 1", Description = "Text value description 1" });
resourceTextAttr.AddLookupValue(new Value { Id = 2, Val = "Text value 2", Description = "Text value description 2" });
project.ExtendedAttributes.Add(resourceTextAttr);

◆ CreateLookupResourceDefinition() [2/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateLookupResourceDefinition ( ExtendedAttributeResource  fieldId,
const System::String &  alias 
)
static

Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Resources only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id.

Parameters
fieldIdThe specified ExtendedAttributeResource field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified fieldId and alias .

Use this example to create a custom field definition for a resource with lookup and then fill it with text values:

var resourceTextAttr = ExtendedAttributeDefinition.CreateLookupResourceDefinition(ExtendedAttributeResource.Text27, "My custom field");
resourceTextAttr.AddLookupValue(new Value { Id = 1, Val = "Text value 1", Description = "Text value description 1" });
resourceTextAttr.AddLookupValue(new Value { Id = 2, Val = "Text value 2", Description = "Text value description 2" });
project.ExtendedAttributes.Add(resourceTextAttr);

◆ CreateLookupTaskDefinition() [1/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateLookupTaskDefinition ( CustomFieldType  customFieldType,
ExtendedAttributeTask  fieldId,
const System::String &  alias 
)
static

Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Tasks only. You are required to specify customFieldType , fieldId and alias when call this method.

Parameters
customFieldTypeThe specified CustomFieldType type.
fieldIdThe specified ExtendedAttributeTask field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified customFieldType , fieldId and alias .

Use this example to create a custom field definition for a task with lookup and then fill it with text values:

var taskTextAttr = ExtendedAttributeDefinition.CreateLookupTaskDefinition(CustomFieldType.Text, ExtendedAttributeTask.Text27, "My custom field");
taskTextAttr.AddLookupValue(new Value { Id = 1, Val = "Text value 1", Description = "Text value description 1" });
taskTextAttr.AddLookupValue(new Value { Id = 2, Val = "Text value 2", Description = "Text value description 2" });
project.ExtendedAttributes.Add(taskTextAttr);

◆ CreateLookupTaskDefinition() [2/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateLookupTaskDefinition ( ExtendedAttributeTask  fieldId,
const System::String &  alias 
)
static

Factory method which creates an extended attribute definition with lookup. It has CalculationType equals to Tasks::CalculationType::Lookup and can be used in Tasks only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id.

Parameters
fieldIdThe specified ExtendedAttributeTask field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified fieldId and alias .

Use this example to create a custom field definition for a task with lookup and then fill it with text values:

var taskTextAttr = ExtendedAttributeDefinition.CreateLookupTaskDefinition(ExtendedAttributeTask.Text27, "My custom field");
taskTextAttr.AddLookupValue(new Value { Id = 1, Val = "Text value 1", Description = "Text value description 1" });
taskTextAttr.AddLookupValue(new Value { Id = 2, Val = "Text value 2", Description = "Text value description 2" });
project.ExtendedAttributes.Add(taskTextAttr);

◆ CreateResourceDefinition() [1/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateResourceDefinition ( CustomFieldType  customFieldType,
ExtendedAttributeResource  fieldId,
const System::String &  alias 
)
static

Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Resource only. You are required to specify customFieldType , fieldId and alias when call this method.

Parameters
customFieldTypeThe specified CustomFieldType type.
fieldIdThe specified ExtendedAttributeResource field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified customFieldType , fieldId and alias .

Use this example to create a custom text field definition:

var resourceTextAttr = ExtendedAttributeDefinition.CreateResourceDefinition(CustomFieldType.Text, ExtendedAttributeResource.Text27, "My custom field");
project.ExtendedAttributes.Add(resourceTextAttr);

◆ CreateResourceDefinition() [2/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateResourceDefinition ( ExtendedAttributeResource  fieldId,
const System::String &  alias 
)
static

Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Resource only. You are required to specify fieldId and alias when call this method. The field type is inferred from field id.

Parameters
fieldIdThe specified ExtendedAttributeResource field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified fieldId and alias .

Use this example to create a custom text field definition:

var resourceTextAttr = ExtendedAttributeDefinition.CreateResourceDefinition(ExtendedAttributeResource.Text27, "My custom field");
project.ExtendedAttributes.Add(resourceTextAttr);

◆ CreateTaskDefinition() [1/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateTaskDefinition ( CustomFieldType  customFieldType,
ExtendedAttributeTask  fieldId,
const System::String &  alias 
)
static

Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Tasks only. You are required to specify customFieldType , fieldId and alias when calling this method.

Parameters
customFieldTypeThe specified CustomFieldType type.
fieldIdThe specified ExtendedAttributeTask field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified customFieldType , fieldId and alias .

Use this example to create a custom text field definition:

var taskTextAttr = ExtendedAttributeDefinition.CreateTaskDefinition(CustomFieldType.Text, ExtendedAttributeTask.Text27, "My custom field");
project.ExtendedAttributes.Add(taskTextAttr);

◆ CreateTaskDefinition() [2/2]

static System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttributeDefinition::CreateTaskDefinition ( ExtendedAttributeTask  fieldId,
const System::String &  alias 
)
static

Factory method which creates a simple extended attribute definition, which Microsoft Project shows as "None". It has CalculationType equals to Tasks::CalculationType::None and can be used in Tasks only. You are required to specify fieldId and alias when calling this method. The field type is inferred from field id.

Parameters
fieldIdThe specified ExtendedAttributeTask field ID.
aliasThe specified System::String alias.
Returns
Created instance of the ExtendedAttributeDefinition class with specified fieldId and alias .

Use this example to create a custom text field definition:

var taskTextAttr = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Text27, "My custom field");
project.ExtendedAttributes.Add(taskTextAttr);

◆ Equals()

bool Aspose::Tasks::ExtendedAttributeDefinition::Equals ( System::SharedPtr< System::Object >  obj)
override

Returns a flag indicating whether this instance is equal to the specified object.

Parameters
objthe specified object to compare to this instance.
Returns
a flag indicating whether this instance is equal to the specified object.

◆ get_Alias()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_Alias ( ) const

Gets the alias of a custom field.

◆ get_AppendNewValues()

bool Aspose::Tasks::ExtendedAttributeDefinition::get_AppendNewValues ( ) const

Gets a value indicating whether new values added to a project are automatically added to the list.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.

◆ get_AutoRollDown()

bool Aspose::Tasks::ExtendedAttributeDefinition::get_AutoRollDown ( ) const

Gets a value indicating whether an automatic roll down to assignments is enabled.

◆ get_CalculationType()

Aspose::Tasks::CalculationType Aspose::Tasks::ExtendedAttributeDefinition::get_CalculationType ( ) const

Gets the type of calculation of the custom attribute's value.

◆ get_CfType()

CustomFieldType Aspose::Tasks::ExtendedAttributeDefinition::get_CfType ( )

Gets the type of a custom field.

◆ get_Default()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_Default ( ) const

Gets the default value in the list.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.

◆ get_DefaultGuid()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_DefaultGuid ( ) const

Gets the Guid of the default lookup table entry.

◆ get_ElementType()

Aspose::Tasks::ElementType Aspose::Tasks::ExtendedAttributeDefinition::get_ElementType ( )

Gets the extended attribute is associated with a task, a resource or an assignment.

◆ get_FieldId()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_FieldId ( ) const

Gets corresponds to the project id of a custom field. Use string representation of a constant from Aspose::Tasks::ExtendedAttributeTask class to specify FieldId property.

Preferable way to set FieldId property is to create ExtendedAttributeDefinition using one of the dedicated factory methods like CreateTaskDefinition(ExtendedAttributeTask, string) or CreateLookupTaskDefinition(CustomFieldType, ExtendedAttributeTask, string).

customFieldDefinition.FieldId = Aspose.Tasks.ExtendedAttributeTask.Number10.ToString("D");
Definition: Asn.h:15
Definition: Asn.h:13

◆ get_FieldName()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_FieldName ( ) const

Gets the name of a custom field.

Should not be set directly, instead create ExtendedAttributeDefinition using strongly typed static factory methods named like Create*Definition().

◆ get_Formula()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_Formula ( )

Gets the formula that Microsoft Project uses to populate a custom task field.

◆ get_Guid()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_Guid ( ) const

Gets the Guid of a custom field.

Currently supported for Xml format only.

◆ get_LookupUid()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_LookupUid ( ) const

Gets a Guid of the lookup table associated with a custom field.

In order to create a custom field with lookup, use one of the factory methods: CreateLookupTaskDefinition(CustomFieldType, ExtendedAttributeTask, string) or CreateLookupResourceDefinition(CustomFieldType, ExtendedAttributeResource, string).

◆ get_MaxMultiValues()

int32_t Aspose::Tasks::ExtendedAttributeDefinition::get_MaxMultiValues ( ) const

Gets the maximum number of values you can set in a pick list.

Currently supported for Xml format only.

◆ get_ParentProject()

System::SharedPtr<Project> Aspose::Tasks::ExtendedAttributeDefinition::get_ParentProject ( ) const

Gets the parent project for the ExtendedAttributeDefinition instance.

◆ get_PhoneticsAlias()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_PhoneticsAlias ( ) const

Gets the phonetic pronunciation of the alias of a custom field.

Currently supported for Xml format only.

◆ get_RestrictValues()

bool Aspose::Tasks::ExtendedAttributeDefinition::get_RestrictValues ( ) const

Gets a value indicating whether the custom field values are restricted to values in the ValueList.

◆ get_RollupType()

Aspose::Tasks::RollupType Aspose::Tasks::ExtendedAttributeDefinition::get_RollupType ( ) const

Gets the way rollups are calculated.

Writing currently supported for Xml format only.

◆ get_SecondaryGuid()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_SecondaryGuid ( ) const

Gets the secondary guid of extended attribute.

This is new for MS Project 2010 property.

◆ get_SecondaryPid()

System::String Aspose::Tasks::ExtendedAttributeDefinition::get_SecondaryPid ( ) const

Gets the secondary PID of a custom field.

◆ get_SummaryRowsCalculationType()

Aspose::Tasks::SummaryRowsCalculationType Aspose::Tasks::ExtendedAttributeDefinition::get_SummaryRowsCalculationType ( ) const

Gets the type of calculation of the custom attribute's value for summary rows.

◆ get_UserDef()

bool Aspose::Tasks::ExtendedAttributeDefinition::get_UserDef ( ) const

Gets a value indicating whether a custom field is user defined.

Currently supported for Xml format only.

◆ get_ValueList()

const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Value> > >& Aspose::Tasks::ExtendedAttributeDefinition::get_ValueList ( ) const

Gets the List<Value> ValueList.

When values of extended attributes are specified as properties of elements in the schema, they may either be specified by values or by references to the values contained in this list. Applications may assume ordering of the list by ordering specified here. Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats. Do not change this list directly. Use ExtendedAttributeDefinition.AddLookupValue/RemoveLookupValue methods instead.

◆ get_ValuelistSortOrder()

int32_t Aspose::Tasks::ExtendedAttributeDefinition::get_ValuelistSortOrder ( ) const

Gets the way value lists are sorted. Values are: 0=Descending, 1=Ascending.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.

◆ GetHashCode()

int32_t Aspose::Tasks::ExtendedAttributeDefinition::GetHashCode ( ) const
override

Returns a hash code for the instance of the ExtendedAttributeDefinition class.

Returns
a hash code for this object.

◆ RemoveLookupValue()

void Aspose::Tasks::ExtendedAttributeDefinition::RemoveLookupValue ( const System::SharedPtr< Value > &  value)

Removes a value from the internal lookup list. This is a preferable way for manipulations with the ValueList.

Parameters
valueValue to remove from lookup.

This method works only for ExtendedAttributeDefinition instances which have CalculationType equals to Tasks::CalculationType::Lookup.

◆ set_Alias()

void Aspose::Tasks::ExtendedAttributeDefinition::set_Alias ( const System::String &  value)

Sets the alias of a custom field.

◆ set_AppendNewValues()

void Aspose::Tasks::ExtendedAttributeDefinition::set_AppendNewValues ( bool  value)

Sets a value indicating whether new values added to a project are automatically added to the list.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.

◆ set_AutoRollDown()

void Aspose::Tasks::ExtendedAttributeDefinition::set_AutoRollDown ( bool  value)

Sets a value indicating whether an automatic roll down to assignments is enabled.

◆ set_CalculationType()

void Aspose::Tasks::ExtendedAttributeDefinition::set_CalculationType ( Aspose::Tasks::CalculationType  value)

Sets the type of calculation of the custom attribute's value.

◆ set_Default()

void Aspose::Tasks::ExtendedAttributeDefinition::set_Default ( const System::String &  value)

Sets the default value in the list.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.

◆ set_DefaultGuid()

void Aspose::Tasks::ExtendedAttributeDefinition::set_DefaultGuid ( const System::String &  value)

Sets the Guid of the default lookup table entry.

◆ set_ElementType()

void Aspose::Tasks::ExtendedAttributeDefinition::set_ElementType ( Aspose::Tasks::ElementType  value)

Sets the extended attribute is associated with a task, a resource or an assignment.

◆ set_FieldId()

void Aspose::Tasks::ExtendedAttributeDefinition::set_FieldId ( const System::String &  value)

Sets corresponds to the project id of a custom field. Use string representation of a constant from Aspose::Tasks::ExtendedAttributeTask class to specify FieldId property.

Preferable way to set FieldId property is to create ExtendedAttributeDefinition using one of the dedicated factory methods like CreateTaskDefinition(ExtendedAttributeTask, string) or CreateLookupTaskDefinition(CustomFieldType, ExtendedAttributeTask, string).

customFieldDefinition.FieldId = Aspose.Tasks.ExtendedAttributeTask.Number10.ToString("D");

◆ set_Formula()

void Aspose::Tasks::ExtendedAttributeDefinition::set_Formula ( const System::String &  value)

Sets the formula that Microsoft Project uses to populate a custom task field.

◆ set_Guid()

void Aspose::Tasks::ExtendedAttributeDefinition::set_Guid ( const System::String &  value)

Sets the Guid of a custom field.

Currently supported for Xml format only.

◆ set_MaxMultiValues()

void Aspose::Tasks::ExtendedAttributeDefinition::set_MaxMultiValues ( int32_t  value)

Sets the maximum number of values you can set in a pick list.

Currently supported for Xml format only.

◆ set_PhoneticsAlias()

void Aspose::Tasks::ExtendedAttributeDefinition::set_PhoneticsAlias ( const System::String &  value)

Sets the phonetic pronunciation of the alias of a custom field.

Currently supported for Xml format only.

◆ set_RestrictValues()

void Aspose::Tasks::ExtendedAttributeDefinition::set_RestrictValues ( bool  value)

Sets a value indicating whether the custom field values are restricted to values in the ValueList.

◆ set_RollupType()

void Aspose::Tasks::ExtendedAttributeDefinition::set_RollupType ( Aspose::Tasks::RollupType  value)

Sets the way rollups are calculated.

Writing currently supported for Xml format only.

◆ set_SecondaryGuid()

void Aspose::Tasks::ExtendedAttributeDefinition::set_SecondaryGuid ( const System::String &  value)

Sets the secondary guid of extended attribute.

This is new for MS Project 2010 property.

◆ set_SecondaryPid()

void Aspose::Tasks::ExtendedAttributeDefinition::set_SecondaryPid ( const System::String &  value)

Sets the secondary PID of a custom field.

◆ set_SummaryRowsCalculationType()

void Aspose::Tasks::ExtendedAttributeDefinition::set_SummaryRowsCalculationType ( Aspose::Tasks::SummaryRowsCalculationType  value)

Sets the type of calculation of the custom attribute's value for summary rows.

◆ set_UserDef()

void Aspose::Tasks::ExtendedAttributeDefinition::set_UserDef ( bool  value)

Sets a value indicating whether a custom field is user defined.

Currently supported for Xml format only.

◆ set_ValuelistSortOrder()

void Aspose::Tasks::ExtendedAttributeDefinition::set_ValuelistSortOrder ( int32_t  value)

Sets the way value lists are sorted. Values are: 0=Descending, 1=Ascending.

Currently supported for MSP 2003/2007 Xml and MSP 2003 mpp formats.