StageDetailPageCollection class
inherits members from ClientObjectCollection
Represents a collection of project detail pages (PDPs) that are visible in a workflow stage.
Syntax
CSOM
class StageDetailPageCollection
JSOM
PS.StageDetailPageCollection
REST Interface
Supported.
PS.StageDetailPageCollection
http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{stageid}')/ProjectDetailPages
Members
✓ - Read Support ✓ʷ - Write Support
Properties
| Name | .NET | JSOM | REST | Type | Description |
|---|---|---|---|---|---|
| [Integer] | ✓ | StageDetailPage | Gets a StageDetailPage from the collection at the specified index. | ||
| Item | ✓ | StageDetailPage | Gets a StageDetailPage from the collection at the specified index. |
Methods
| Name | .NET | JSOM | REST | Return Type | Description |
|---|---|---|---|---|---|
| '{StageDetailPageId}' | ✓ | StageDetailPage | Gets a StageDetailPage from the collection with the specified StageDetailPageId. | ||
| Add(StageDetailPageCreationInformation parameters) | ✓ | ✓ | ✓ | StageDetailPage | Adds the StageDetailPage that is specified by the StageDetailPageCreationInformation object to the collection. |
| GetByGuid(Guid uid) | ✓ | ✓ | ✓ | StageDetailPage | Gets a StageDetailPage from the collection with the Guid value. |
| GetById(String objectId) | ✓ | ✓ | ✓ | StageDetailPage | Gets a StageDetailPage from the collection with the Id value. |
| Remove(StageDetailPage pdp) | ✓ | ✓ | Boolean | Removes the specified StageDetailPage from the collection. |
#### Method Details
'{StageDetailPageId}'
Gets a StageDetailPage from the collection with the specified StageDetailPageId.
Syntax
StageDetailPage http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Stages('{stageid}')/ProjectDetailPages('{StageDetailPageId}')
Parameters
| Name | Type | Description |
|---|---|---|
| StageDetailPageId | String | the id of the StageDetailPage |
Return Value
Add(StageDetailPageCreationInformation parameters)
Adds the StageDetailPage that is specified by the StageDetailPageCreationInformation object to the collection.
Syntax
StageDetailPage Add(StageDetailPageCreationInformation parameters)
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | StageDetailPageCreationInformation | The properties that can be set when creating a stage detail page. |
Return Value
GetByGuid(Guid uid)
Gets a StageDetailPage from the collection with the Guid value.
Syntax
StageDetailPage GetByGuid(Guid uid)
Parameters
| Name | Type | Description |
|---|---|---|
| uid | Guid | The Guid of the StageDetailPage |
Return Value
GetById(String objectId)
Gets a StageDetailPage from the collection with the Id value.
Syntax
StageDetailPage GetById(String objectId)
Parameters
| Name | Type | Description |
|---|---|---|
| objectId | String | The id of the StageDetailPage. |
Return Value
Remove(StageDetailPage pdp)
Removes the specified StageDetailPage from the collection.
Syntax
Boolean Remove(StageDetailPage pdp)
Parameters
| Name | Type | Description |
|---|---|---|
| pdp | StageDetailPage | The StageDetailPage to remove. |
Return Value
Boolean