Class View
- java.lang.Object
-
- com.aspose.tasks.View
-
- All Implemented Interfaces:
Comparable<View>
- Direct Known Subclasses:
GanttChartView,TimelineView,UsageView
public class View extends Object implements Comparable<View>
Represents a view in Project.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(View other)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.booleanequals(Object obj)Returns a value indicating whether this instance is equal to a specified object.static ViewforViewScreen(int viewScreen)Constructs a new instance of theViewclass.FiltergetFilter()Gets a filter used in a single view.GroupgetGroup()Gets a group of the single view.booleangetHighlightFilter()Gets a value indicating whether Microsoft Project highlights the filter for a single view.StringgetName()Gets the name of a View object.PageInfogetPageInfo()Gets an instance of thePageInfo(getPageInfo()) class.ProjectgetParentProject()Gets the parent of the View object.intgetScreen()Gets the screen type for the single view.booleangetShowInMenu()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.TablegetTable()Gets a table of the single view.intgetType()Gets the type of item in the single view, such as tasks or resources.intgetUid()Gets the unique identifier of a view.List<VisualObjectPlacement>getVisualObjectsPlacements()Gets a collection of objects representing placement and appearance ofOleObjectin the view.inthashCode()Returns a hash code value for the instance of theResourceclass.static booleanop_Equality(View a, View b)Returns a value indicating whether this instance is equal to a specified object.static booleanop_GreaterThan(View a, View b)Returns a value indicating whether this instance is greater than a specified object.static booleanop_GreaterThanOrEqual(View a, View b)Returns a value indicating whether this instance is greater than or equal to a specified object.static booleanop_Inequality(View a, View b)Returns a value indicating whether this instance is not equal to a specified object.static booleanop_LessThan(View a, View b)Returns a value indicating whether this instance is less than a specified object.static booleanop_LessThanOrEqual(View a, View b)Returns a value indicating whether this instance is less than or equal to a specified object.voidsetFilter(Filter value)Sets a filter used in a single view.voidsetGroup(Group value)Sets a group of the single view.voidsetHighlightFilter(boolean value)Sets a value indicating whether Microsoft Project highlights the filter for a single view.voidsetName(String value)Sets the name of a View object.voidsetShowInMenu(boolean 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.voidsetTable(Table value)Sets a table of the single view.
-
-
-
Constructor Detail
-
View
public View()
Initializes a new instance of the
Viewclass.
-
-
Method Detail
-
compareTo
public final int compareTo(View other)
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.
- Specified by:
compareToin interfaceComparable<View>- Parameters:
other- the specified View object to compare this instance to.- 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
otherin the sort order. Zero This instance occurs in the same position in the sort order asother. Greater than zero This instance followsotherin the sort order.
-
equals
public boolean equals(Object obj)
Returns a value indicating whether this instance is equal to a specified object.
-
getFilter
public final Filter getFilter()
Gets a filter used in a single view.
- Returns:
- a filter used in a single view.
-
setFilter
public final void setFilter(Filter value)
Sets a filter used in a single view.
- Parameters:
value- a filter used in a single view.
-
getGroup
public final Group getGroup()
Gets a group of the single view.
- Returns:
- a group of the single view.
-
setGroup
public final void setGroup(Group value)
Sets a group of the single view.
- Parameters:
value- a group of the single view.
-
getHighlightFilter
public final boolean getHighlightFilter()
Gets a value indicating whether Microsoft Project highlights the filter for a single view.
- Returns:
- a value indicating whether Microsoft Project highlights the filter for a single view.
-
setHighlightFilter
public final void setHighlightFilter(boolean value)
Sets a value indicating whether Microsoft Project highlights the filter for a single view.
- Parameters:
value- a value indicating whether Microsoft Project highlights the filter for a single view.
-
getName
public final String getName()
Gets the name of a View object.
- Returns:
- the name of a View object.
-
setName
public final void setName(String value)
Sets the name of a View object.
- Parameters:
value- the name of a View object.
-
getPageInfo
public final PageInfo getPageInfo()
Gets an instance of the
PageInfo(getPageInfo()) class. Represents page setup data which is present in mpp file format.- Returns:
- an instance of the
PageInfo(getPageInfo()) class.
-
getParentProject
public final Project getParentProject()
Gets the parent of the View object. Read-only
Project.- Returns:
- the parent of the View object.
-
getScreen
public final int getScreen()
Gets the screen type for the single view. Read-only
ViewScreen.- Returns:
- the screen type for the single view.
-
getShowInMenu
public final boolean getShowInMenu()
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.
- Returns:
- a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.
-
setShowInMenu
public final void setShowInMenu(boolean 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.
- Parameters:
value- a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.
-
getTable
public final Table getTable()
Gets a table of the single view.
- Returns:
- a table of the single view.
-
setTable
public final void setTable(Table value)
Sets a table of the single view.
- Parameters:
value- a table of the single view.
-
getType
public final int getType()
Gets the type of item in the single view, such as tasks or resources. Read-only
ItemType.- Returns:
- the type of item in the single view, such as tasks or resources.
-
getUid
public final int getUid()
Gets the unique identifier of a view.
- Returns:
- the unique identifier of a view.
-
getVisualObjectsPlacements
public final List<VisualObjectPlacement> getVisualObjectsPlacements()
Gets a collection of objects representing placement and appearance of
OleObjectin the view.- Returns:
- a collection of objects representing placement and appearance of
OleObjectin the view.
-
hashCode
public int hashCode()
Returns a hash code value for the instance of the
Resourceclass.
-
op_Equality
public static boolean op_Equality(View a, View b)
Returns a value indicating whether this instance is equal to a specified object.
- Parameters:
a- The first view.b- The second view.- Returns:
- a value indicating whether this instance is equal to a specified object
-
op_GreaterThan
public static boolean op_GreaterThan(View a, View b)
Returns a value indicating whether this instance is greater than a specified object.
- Parameters:
a- The first view.b- The second view.- Returns:
- a value indicating whether this instance is greater than a specified object
-
op_GreaterThanOrEqual
public static boolean op_GreaterThanOrEqual(View a, View b)
Returns a value indicating whether this instance is greater than or equal to a specified object.
- Parameters:
a- The first view.b- The second view.- Returns:
- a value indicating whether this instance is greater than or equal to a specified object
-
op_Inequality
public static boolean op_Inequality(View a, View b)
Returns a value indicating whether this instance is not equal to a specified object.
- Parameters:
a- The first view.b- The second view.- Returns:
- a value indicating whether this instance is not equal to a specified object
-
op_LessThan
public static boolean op_LessThan(View a, View b)
Returns a value indicating whether this instance is less than a specified object.
- Parameters:
a- The first filter.b- The second filter.- Returns:
- a value indicating whether this instance is less than a specified object
-
op_LessThanOrEqual
public static boolean op_LessThanOrEqual(View a, View b)
Returns a value indicating whether this instance is less than or equal to a specified object.
- Parameters:
a- The first view.b- The second view.- Returns:
- a value indicating whether this instance is less than or equal to a specified object
-
-