public class Filter extends Object implements Comparable<Filter>
Represents a filter in Project.
Constructor and Description |
---|
Filter() |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Filter other)
Returns a value indicating whether this instance is greater or less than a specified object.
|
boolean |
equals(Object obj)
Returns a value indicating whether this instance is equal to a specified object.
|
FilterCriteria |
getCriteria()
Gets a criteria that tasks or resources must meet to be displayed in MSP view.
|
int |
getFilterType()
Gets the type of the filter.
|
int |
getIndex()
Gets the index of a
Filter object in the Filters containing object. |
String |
getName()
Gets a name of a Filter object.
|
Project |
getParentProject()
Gets the parent of the Filter object.
|
boolean |
getShowInMenu()
Gets true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
|
boolean |
getShowRelatedSummaryRows()
Gets true if related summary rows are to be displayed for the filter.
|
int |
getUid()
Gets the unique identifier of a filter.
|
int |
hashCode()
Returns a hash code for this Filter.
|
void |
setCriteria(FilterCriteria value)
Sets a criteria that tasks or resources must meet to be displayed in MSP view.
|
void |
setName(String value)
Sets a name of a Filter object.
|
void |
setShowInMenu(boolean value)
Set to true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.
|
void |
setShowRelatedSummaryRows(boolean value)
Set to true if related summary rows are to be displayed for the filter.
|
public int getFilterType()
Gets the type of the filter.
Read-only ItemType
.
public String getName()
Gets a name of a Filter object.
Read/write string
.
public void setName(String value)
value
- a name of a Filter object.public boolean getShowInMenu()
Gets true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false. Read/write Boolean.
public void setShowInMenu(boolean value)
value
- true if Project shows the filter name in the Filter drop-down list on the View tab of the Ribbon; otherwise, false.public boolean getShowRelatedSummaryRows()
Gets true if related summary rows are to be displayed for the filter. Read/write Boolean.
public void setShowRelatedSummaryRows(boolean value)
value
- true if related summary rows are to be displayed for the filter; otherwise, false.public int getIndex()
Gets the index of a Filter
object in the Filters containing object.
Read-only int
.
Filter
object in the Filters containing object.public int getUid()
Gets the unique identifier of a filter.
public Project getParentProject()
Gets the parent of the Filter object.
Read-only Project
.
public FilterCriteria getCriteria()
Gets a criteria that tasks or resources must meet to be displayed in MSP view.
public void setCriteria(FilterCriteria value)
value
- a criteria that tasks or resources must meet to be displayed in MSP view.public int compareTo(Filter other)
compareTo
in interface Comparable<Filter>
other
- The object to compare with this instance.public boolean equals(Object obj)
Returns a value indicating whether this instance is equal to a specified object.
Copyright (c) 2008-2015 Aspose Pty Ltd. All Rights Reserved.