Aspose.Tasks for C++
Group.h
1 #pragma once
2 //-----------------------------------------------------------------------
3 // <copyright file="Group.cs" company="Aspose Pty Ltd">
4 // Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
5 // </copyright>
6 //-----------------------------------------------------------------------
7 
8 #include <system/string.h>
9 #include <cstdint>
10 
11 #include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
12 
13 namespace Aspose
14 {
15 namespace Tasks
16 {
17 class GroupCollection;
18 class GroupCriterionCollection;
19 namespace IO
20 {
21 namespace MSProject
22 {
23 class MPP12Reader;
24 class MPP14Reader;
25 class MPP9Reader;
26 class MPPGroupReader;
27 } // namespace MSProject
28 } // namespace IO
29 enum class ItemType;
30 } // namespace Tasks
31 } // namespace Aspose
32 
33 namespace Aspose {
34 
35 namespace Tasks {
36 
37 /// <summary>
38 /// Represents a group definition.
39 /// A Group object is a member of the ResourceGroups collection or the TaskGroups collection.
40 /// </summary>
41 class ASPOSE_TASKS_SHARED_CLASS Group : public System::Object
42 {
43  typedef Group ThisType;
44  typedef System::Object BaseType;
45 
46  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
47  ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
48 
49  friend class Aspose::Tasks::GroupCollection;
50  friend class Aspose::Tasks::IO::MSProject::MPP12Reader;
51  friend class Aspose::Tasks::IO::MSProject::MPP14Reader;
52  friend class Aspose::Tasks::IO::MSProject::MPP9Reader;
53  friend class Aspose::Tasks::IO::MSProject::MPPGroupReader;
54 
55 public:
56 
57  /// <summary>
58  /// Gets a name of a Group object.
59  /// </summary>
60  ASPOSE_TASKS_SHARED_API System::String get_Name() const;
61  /// <summary>
62  /// Sets a name of a Group object.
63  /// </summary>
64  ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
65  /// <summary>
66  /// Gets the index of a <see cref="Group"></see> object in the Groups containing object.
67  /// </summary>
68  ASPOSE_TASKS_SHARED_API int32_t get_Index() const;
69  /// <summary>
70  /// Gets a unique identifier of a group.
71  /// </summary>
72  ASPOSE_TASKS_SHARED_API int32_t get_Uid() const;
73  /// <summary>
74  /// Gets a value indicating whether summary rows are displayed for the group.
75  /// </summary>
76  ASPOSE_TASKS_SHARED_API bool get_ShowSummary() const;
77  /// <summary>
78  /// Sets a value indicating whether summary rows are displayed for the group.
79  /// </summary>
80  ASPOSE_TASKS_SHARED_API void set_ShowSummary(bool value);
81  /// <summary>
82  /// Gets a value indicating whether to show all the levels of summary tasks for subtasks within group.
83  /// </summary>
84  ASPOSE_TASKS_SHARED_API bool get_MaintainHierarchy() const;
85  /// <summary>
86  /// Sets a value indicating whether to show all the levels of summary tasks for subtasks within group.
87  /// </summary>
88  ASPOSE_TASKS_SHARED_API void set_MaintainHierarchy(bool value);
89  /// <summary>
90  /// Gets a value indicating whether Project shows the group name in the Group drop-down list in the Ribbon.
91  /// </summary>
92  ASPOSE_TASKS_SHARED_API bool get_ShowInMenu() const;
93  /// <summary>
94  /// Sets a value indicating whether Project shows the group name in the Group drop-down list in the Ribbon.
95  /// </summary>
96  ASPOSE_TASKS_SHARED_API void set_ShowInMenu(bool value);
97  /// <summary>
98  /// Gets a GroupCriteria collection representing the fields in a group definition.
99  /// </summary>
100  ASPOSE_TASKS_SHARED_API const System::SharedPtr<GroupCriterionCollection>& get_GroupCriteria() const;
101  /// <summary>
102  /// Sets a GroupCriteria collection representing the fields in a group definition.
103  /// </summary>
104  ASPOSE_TASKS_SHARED_API void set_GroupCriteria(const System::SharedPtr<GroupCriterionCollection>& value);
105 
106  /// <summary>
107  /// Initializes a new instance of the <see cref="Group"></see> class.
108  /// </summary>
109  ASPOSE_TASKS_SHARED_API Group();
110 
111 protected:
112 
113  /// <summary>
114  /// Gets the index of a <see cref="Group"></see> object in the Groups containing object.
115  /// </summary>
116  ASPOSE_TASKS_SHARED_API void set_Index(int32_t value);
117  /// <summary>
118  /// Gets a unique identifier of a group.
119  /// </summary>
120  ASPOSE_TASKS_SHARED_API void set_Uid(int32_t value);
121  ASPOSE_TASKS_SHARED_API Aspose::Tasks::ItemType get_ItemType() const;
122  ASPOSE_TASKS_SHARED_API void set_ItemType(Aspose::Tasks::ItemType value);
123 
124  virtual ASPOSE_TASKS_SHARED_API ~Group();
125 
126  #ifdef ASPOSE_GET_SHARED_MEMBERS
127  ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
128  #endif
129 
130 
131 private:
132 
133  System::String pr_Name;
134  int32_t pr_Index;
135  int32_t pr_Uid;
136  bool pr_ShowSummary;
137  bool pr_MaintainHierarchy;
138  bool pr_ShowInMenu;
139  System::SharedPtr<GroupCriterionCollection> pr_GroupCriteria;
140  Aspose::Tasks::ItemType pr_ItemType;
141 
142 };
143 
144 } // namespace Tasks
145 } // namespace Aspose
146 
147 
Contains a list of Group objects. Implements ICollection<Group> interface.
Definition: GroupCollection.h:51
Represents a group definition. A Group object is a member of the ResourceGroups collection or the Tas...
Definition: Group.h:42
System::String get_Name() const
Gets a name of a Group object.
void set_Name(const System::String &value)
Sets a name of a Group object.
void set_MaintainHierarchy(bool value)
Sets a value indicating whether to show all the levels of summary tasks for subtasks within group.
void set_ShowInMenu(bool value)
Sets a value indicating whether Project shows the group name in the Group drop-down list in the Ribbo...
bool get_MaintainHierarchy() const
Gets a value indicating whether to show all the levels of summary tasks for subtasks within group.
int32_t get_Uid() const
Gets a unique identifier of a group.
bool get_ShowInMenu() const
Gets a value indicating whether Project shows the group name in the Group drop-down list in the Ribbo...
bool get_ShowSummary() const
Gets a value indicating whether summary rows are displayed for the group.
int32_t get_Index() const
Gets the index of a Group object in the Groups containing object.
void set_ShowSummary(bool value)
Sets a value indicating whether summary rows are displayed for the group.
void set_GroupCriteria(const System::SharedPtr< GroupCriterionCollection > &value)
Sets a GroupCriteria collection representing the fields in a group definition.
const System::SharedPtr< GroupCriterionCollection > & get_GroupCriteria() const
Gets a GroupCriteria collection representing the fields in a group definition.
Group()
Initializes a new instance of the Group class.
Definition: Asn.h:13