Aspose::Tasks::ExtendedAttribute Class Reference

Represents extended attributes. More...

#include <ExtendedAttribute.h>

Inherits System::Object.

Public Member Functions
System::SharedPtr< ExtendedAttributeDefinition >	get_AttributeDefinition () const
	Gets the attribute definition. More...
System::String	get_FieldId () const
	Gets the id of a field. More...
Duration	get_DurationValue ()
	Gets value for attributes with 'Duration' type. More...
void	set_DurationValue (Duration value)
	Sets value for attributes with 'Duration' type. More...
System::Decimal	get_NumericValue ()
	Gets a value for attributes with numeric types (Cost, Number). More...
void	set_NumericValue (System::Decimal value)
	Sets a value for attributes with numeric types (Cost, Number). More...
System::DateTime	get_DateValue ()
	Gets a value for attributes with date types (Date, Start, Finish). More...
void	set_DateValue (System::DateTime value)
	Sets a value for attributes with date types (Date, Start, Finish). More...
bool	get_FlagValue ()
	Gets a value indicating whether a flag is set for an attribute with 'Flag' type. More...
void	set_FlagValue (bool value)
	Sets a value indicating whether a flag is set for an attribute with 'Flag' type. More...
System::String	get_TextValue ()
	Gets a value for attributes with 'Text' type. More...
void	set_TextValue (const System::String &value)
	Sets a value for attributes with 'Text' type. More...
System::String	get_ValueGuid () const
	Gets the guid of a lookup value. More...
bool	get_ValueReadOnly () const
	Gets a value indicating whether a value of this ExtendedAttribute instance is read-only. returns true if a formula or rollup is defined in the ExtendedAttributeDefinition for this object. More...
bool	get_IsErrorValue ()
	Gets whether calculation of extended attribute's value resulted in an error. More...
System::String	ToString () const override
	Returns short string representation of an extended attribute. More...

Detailed Description

Represents extended attributes.

Currently supported all types of Extended attributes reading from MSP Xml 2003/2007 and mpp 2003. For MSP mpp 2007 all Extended attributes reading supported except durations and flags.

Member Function Documentation

get_AttributeDefinition()

System::SharedPtr<ExtendedAttributeDefinition> Aspose::Tasks::ExtendedAttribute::get_AttributeDefinition

(

)

const

Gets the attribute definition.

get_DateValue()

System::DateTime Aspose::Tasks::ExtendedAttribute::get_DateValue

(

)

Gets a value for attributes with date types (Date, Start, Finish).

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not an date attribute.

get_DurationValue()

Duration Aspose::Tasks::ExtendedAttribute::get_DurationValue

(

)

Gets value for attributes with 'Duration' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or custom field type of ExtendedAttribute::AttributeDefinition property is not a Duration instance.

get_FieldId()

System::String Aspose::Tasks::ExtendedAttribute::get_FieldId

(

)

const

Gets the id of a field.

get_FlagValue()

bool Aspose::Tasks::ExtendedAttribute::get_FlagValue

(

)

Gets a value indicating whether a flag is set for an attribute with 'Flag' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not a flag attribute.

get_IsErrorValue()

bool Aspose::Tasks::ExtendedAttribute::get_IsErrorValue

(

)

Gets whether calculation of extended attribute's value resulted in an error.

get_NumericValue()

System::Decimal Aspose::Tasks::ExtendedAttribute::get_NumericValue

(

)

Gets a value for attributes with numeric types (Cost, Number).

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or custom field type of ExtendedAttribute::AttributeDefinition property is not 'Cost' or 'Number'.

get_TextValue()

System::String Aspose::Tasks::ExtendedAttribute::get_TextValue

(

)

Gets a value for attributes with 'Text' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not a text attribute.

get_ValueGuid()

System::String Aspose::Tasks::ExtendedAttribute::get_ValueGuid

(

)

const

Gets the guid of a lookup value.

Should not be set directly, instead use ExtendedAttributeDefinition.CreateExtendedAttribute(Value lookupValue) to create an extended attribute with a lookup value.

get_ValueReadOnly()

bool Aspose::Tasks::ExtendedAttribute::get_ValueReadOnly

(

)

const

Gets a value indicating whether a value of this ExtendedAttribute instance is read-only. returns true if a formula or rollup is defined in the ExtendedAttributeDefinition for this object.

set_DateValue()

void Aspose::Tasks::ExtendedAttribute::set_DateValue

(

System::DateTime

value

)

Sets a value for attributes with date types (Date, Start, Finish).

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not an date attribute.

set_DurationValue()

void Aspose::Tasks::ExtendedAttribute::set_DurationValue

(

Duration

value

)

Sets value for attributes with 'Duration' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or custom field type of ExtendedAttribute::AttributeDefinition property is not a Duration instance.

set_FlagValue()

void Aspose::Tasks::ExtendedAttribute::set_FlagValue

(

bool

value

)

Sets a value indicating whether a flag is set for an attribute with 'Flag' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not a flag attribute.

set_NumericValue()

void Aspose::Tasks::ExtendedAttribute::set_NumericValue

(

System::Decimal

value

)

Sets a value for attributes with numeric types (Cost, Number).

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or custom field type of ExtendedAttribute::AttributeDefinition property is not 'Cost' or 'Number'.

set_TextValue()

void Aspose::Tasks::ExtendedAttribute::set_TextValue

(

const System::String &

value

)

Sets a value for attributes with 'Text' type.

Exceptions

InvalidOperationException

Thrown if the ExtendedAttribute::AttributeDefinition property is not initialized or current attribute is not a text attribute.

ToString()

System::String Aspose::Tasks::ExtendedAttribute::ToString ( ) const

override

Returns short string representation of an extended attribute.

Returns

The string representation of the extended attribute.