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

Represents a view in Project. More...

#include <View.h>

Inherits System::IComparable< System::SharedPtr< Aspose::Tasks::View > >.

Inherited by Aspose::Tasks::GanttChartView, Aspose::Tasks::TimelineView, and Aspose::Tasks::UsageView.

Public Member Functions

System::SharedPtr< Aspose::Tasks::Filterget_Filter ()
 Gets a filter used in a single view. More...
 
void set_Filter (const System::SharedPtr< Aspose::Tasks::Filter > &value)
 Sets a filter used in a single view. More...
 
System::SharedPtr< Aspose::Tasks::Groupget_Group ()
 Gets a group of the single view. More...
 
void set_Group (const System::SharedPtr< Aspose::Tasks::Group > &value)
 Sets a group of the single view. More...
 
int32_t get_Uid () const
 Gets the unique identifier of a view. More...
 
bool get_HighlightFilter () const
 Gets a value indicating whether Microsoft Project highlights the filter for a single view. More...
 
void set_HighlightFilter (bool value)
 Sets a value indicating whether Microsoft Project highlights the filter for a single view. More...
 
System::String get_Name () const
 Gets the name of a View object. More...
 
void set_Name (const System::String &value)
 Sets the name of a View object. More...
 
ViewScreen get_Screen () const
 Gets the screen type for the single view. Read-only ViewScreen. More...
 
const System::SharedPtr< Project > & get_ParentProject () const
 Gets the parent of the View object. Read-only Project. More...
 
System::SharedPtr< Aspose::Tasks::Tableget_Table ()
 Gets a table of the single view. More...
 
void set_Table (const System::SharedPtr< Aspose::Tasks::Table > &value)
 Sets a table of the single view. More...
 
ItemType get_Type () const
 Gets the type of item in the single view, such as tasks or resources. Read-only ItemType. More...
 
bool get_ShowInMenu () const
 Gets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon. More...
 
void set_ShowInMenu (bool value)
 Sets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon. More...
 
System::SharedPtr< Aspose::Tasks::Visualization::PageInfoget_PageInfo () const
 Gets an instance of the PageInfo class. Represents page setup data which is present in mpp file format. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Visualization::VisualObjectPlacement > > > get_VisualObjectsPlacements ()
 Gets a collection of objects representing placement and appearance of OleObject in the view. More...
 
 View ()
 Initializes a new instance of the View class. More...
 
 View (ViewScreen viewScreen)
 Initializes a new instance of the View class. More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Returns a value indicating whether this instance is equal to a specified object. More...
 
int32_t GetHashCode () const override
 Returns a hash code value for the instance of the Resource class. More...
 
int32_t CompareTo (System::SharedPtr< View > other) override
 Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. More...
 

Detailed Description

Represents a view in Project.

Constructor & Destructor Documentation

◆ View() [1/2]

Aspose::Tasks::View::View ( )

Initializes a new instance of the View class.

◆ View() [2/2]

Aspose::Tasks::View::View ( ViewScreen  viewScreen)

Initializes a new instance of the View class.

Parameters
viewScreenThe screen type for which the view can be displayed.

Member Function Documentation

◆ CompareTo()

int32_t Aspose::Tasks::View::CompareTo ( System::SharedPtr< View other)
override

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Returns
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other . Greater than zero This instance follows other in the sort order.
Parameters
otherthe specified View object to compare this instance to.

◆ Equals()

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

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

Parameters
objThe object to compare with this instance.
Returns
True if the specified object is a View that has the same Uid value as this instance; otherwise, false.

◆ get_Filter()

System::SharedPtr<Aspose::Tasks::Filter> Aspose::Tasks::View::get_Filter ( )

Gets a filter used in a single view.

◆ get_Group()

System::SharedPtr<Aspose::Tasks::Group> Aspose::Tasks::View::get_Group ( )

Gets a group of the single view.

◆ get_HighlightFilter()

bool Aspose::Tasks::View::get_HighlightFilter ( ) const

Gets a value indicating whether Microsoft Project highlights the filter for a single view.

◆ get_Name()

System::String Aspose::Tasks::View::get_Name ( ) const

Gets the name of a View object.

◆ get_PageInfo()

System::SharedPtr<Aspose::Tasks::Visualization::PageInfo> Aspose::Tasks::View::get_PageInfo ( ) const

Gets an instance of the PageInfo class. Represents page setup data which is present in mpp file format.

◆ get_ParentProject()

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

Gets the parent of the View object. Read-only Project.

◆ get_Screen()

ViewScreen Aspose::Tasks::View::get_Screen ( ) const

Gets the screen type for the single view. Read-only ViewScreen.

◆ get_ShowInMenu()

bool Aspose::Tasks::View::get_ShowInMenu ( ) const

Gets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.

◆ get_Table()

System::SharedPtr<Aspose::Tasks::Table> Aspose::Tasks::View::get_Table ( )

Gets a table of the single view.

◆ get_Type()

ItemType Aspose::Tasks::View::get_Type ( ) const

Gets the type of item in the single view, such as tasks or resources. Read-only ItemType.

◆ get_Uid()

int32_t Aspose::Tasks::View::get_Uid ( ) const

Gets the unique identifier of a view.

◆ get_VisualObjectsPlacements()

System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Visualization::VisualObjectPlacement> > > Aspose::Tasks::View::get_VisualObjectsPlacements ( )

Gets a collection of objects representing placement and appearance of OleObject in the view.

◆ GetHashCode()

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

Returns a hash code value for the instance of the Resource class.

Returns
returns a hash code value for this object.

◆ set_Filter()

void Aspose::Tasks::View::set_Filter ( const System::SharedPtr< Aspose::Tasks::Filter > &  value)

Sets a filter used in a single view.

◆ set_Group()

void Aspose::Tasks::View::set_Group ( const System::SharedPtr< Aspose::Tasks::Group > &  value)

Sets a group of the single view.

◆ set_HighlightFilter()

void Aspose::Tasks::View::set_HighlightFilter ( bool  value)

Sets a value indicating whether Microsoft Project highlights the filter for a single view.

◆ set_Name()

void Aspose::Tasks::View::set_Name ( const System::String &  value)

Sets the name of a View object.

◆ set_ShowInMenu()

void Aspose::Tasks::View::set_ShowInMenu ( bool  value)

Sets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.

◆ set_Table()

void Aspose::Tasks::View::set_Table ( const System::SharedPtr< Aspose::Tasks::Table > &  value)

Sets a table of the single view.