Aspose::Tasks::ViewCollection Class Reference

Contains a list of View objects. Implements ICollection<View> interface. More...

#include <ViewCollection.h>

Inherits System::Collections::Generic::ICollection< typename >.

Public Member Functions
int32_t	get_Count () const override
	Gets the number of elements contained in this collection. More...
bool	get_IsReadOnly () const override
	Gets a value indicating whether this collection is read-only; otherwise, false. More...
const System::SharedPtr< Project > &	get_ParentProject () const
	Gets the parent of the View object. Read-only Project. More...
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< View > > >	GetEnumerator () override
	Returns an enumerator for this collection. More...
void	Add (const System::SharedPtr< View > &item) override
	Adds the specified item to this collection. More...
void	Clear () override
	Removes all items from this collection. More...
bool	Contains (const System::SharedPtr< View > &item) const override
	Returns true if the specified item is found in this collection; otherwise, false. More...
void	CopyTo (System::ArrayPtr< System::SharedPtr< View >> array, int32_t arrayIndex) override
	Copies the elements of this collection to the specified array, starting at the specified array index. More...
bool	Remove (const System::SharedPtr< View > &item) override
	Removes the first occurrence of a specific object from this collection. More...
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< View > > >	ToList ()
	Converts a view collection to a list of View objects. More...
System::SharedPtr< View >	GetByViewScreen (ViewScreen screen)
	Searches for a View with the specified Screen property, and returns the first occurrence within the collection. More...
System::SharedPtr< View >	GetByName (const System::String &viewName)
	Searches for a View with the name, and returns the first occurrence within the collection. More...

Detailed Description

Contains a list of View objects. Implements ICollection<View> interface.

Member Function Documentation

Add()

void Aspose::Tasks::ViewCollection::Add ( const System::SharedPtr< View > &  item )

override

Adds the specified item to this collection.

Parameters

item	the specified item to add to this collection.

Clear()

void Aspose::Tasks::ViewCollection::Clear ( )

override

Removes all items from this collection.

Contains()

bool Aspose::Tasks::ViewCollection::Contains ( const System::SharedPtr< View > &  item ) const

override

Returns true if the specified item is found in this collection; otherwise, false.

Parameters

item	the specified item to find.

Returns

true if the specified item is found in this collection; otherwise, false.

CopyTo()

void Aspose::Tasks::ViewCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< View >>  array, int32_t  arrayIndex  )

override

Copies the elements of this collection to the specified array, starting at the specified array index.

Parameters

array	the specified one-dimensional array to copy elements to
arrayIndex	the zero-based index of the specified array at which copying begins.

get_Count()

int32_t Aspose::Tasks::ViewCollection::get_Count ( ) const

override

Gets the number of elements contained in this collection.

get_IsReadOnly()

bool Aspose::Tasks::ViewCollection::get_IsReadOnly ( ) const

override

Gets a value indicating whether this collection is read-only; otherwise, false.

get_ParentProject()

const System::SharedPtr<Project>& Aspose::Tasks::ViewCollection::get_ParentProject

(

)

const

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

GetByName()

System::SharedPtr<View> Aspose::Tasks::ViewCollection::GetByName

(

const System::String &

viewName

)

Searches for a View with the name, and returns the first occurrence within the collection.

Parameters

viewName

Name of the View to search.

Returns

The first View in collection with the specified name, if found; otherwise, null.

GetByViewScreen()

System::SharedPtr<View> Aspose::Tasks::ViewCollection::GetByViewScreen

(

ViewScreen

screen

)

Searches for a View with the specified Screen property, and returns the first occurrence within the collection.

Parameters

screen

ViewScreen enumeration value.

Returns

The first View in collection which Screen property matches the specified screen argument, if found; otherwise, null.

GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<View> > > Aspose::Tasks::ViewCollection::GetEnumerator ( )

override

Returns an enumerator for this collection.

Returns

an enumerator for this collection.

Remove()

bool Aspose::Tasks::ViewCollection::Remove ( const System::SharedPtr< View > &  item )

override

Removes the first occurrence of a specific object from this collection.

Parameters

item	the specified object to remove.

Returns

true if the specified object was successfully removed from this collection; otherwise, false.

ToList()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<View> > > Aspose::Tasks::ViewCollection::ToList

(

)

Converts a view collection to a list of View objects.

Returns

Generic list of View objects.