Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Prev Next

SearchWindow Class

The SearchWindow Class provides a method for displaying the results of your operation using the Search Window.

SearchWindow Attributes

Attribute

Remarks

See also

FieldChooserVisible

Boolean

Shows or hides the search Field Chooser.

FiltersVisible

Boolean

Shows or hides the search filters.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

SearchWindow Methods

Method

Remarks

See also

AddColumn (string Name, long Width)

Adds the column into the current Search window.

Returns the column number, or -1 on error.

Parameters:

  • Name: String - Name of the column
  • Width: Long - Width of the column

AddRow (ObjectType ot, String ElementGUID, Long ElementID, String ClassType, VARIANT Values)

Returns the row inserted into the search.

Parameters:

  • ot: ObjectType - the Object Type
  • ElementGUID: String - GUID of the element
  • ElementID: long - Object ID of the element
  • ClassType: String - the type of object
  • Values: an array of values

ClearGrouping ( )

Clear all groupings in the search.

Returns FALSE on error.

ClearSorting ( )

Clear all column sorting in the search.

Returns FALSE on error.

EnsureVisible ( )

Make the Search window visible.

Returns FALSE, if the Search window isn't open.

GetCell (long Row, long Column)

Returns the value of the cell.

Parameters:

  • Row: long - Row number
  • Column: long - Column number

GroupByColumn (long Column)

Sets the group order by column.

Returns FALSE if it cannot group by the specified column.

Parameters:

  • Column: Long - Column number

LoadLayout (string LayoutGUID)

Set the layout of the Search window.

Returns FALSE if the layout cannot be set.

Parameters:

  • LayoutGUID: String - Layout GUID

NewLayout (string LayoutGUID)

Saves the layout of the Search window.

Parameters:

  • LayoutGUID: String - Layout GUID

SetCellString (long Row, long Column, String Data)

Sets a value in a cell.

Parameters:

  • Row: long - Row number
  • Column: long - Column number
  • Data: String - Value to set the cell to

SetCellVariant (long Row, long Column, VARIANT Data)

Sets an alternative value in a cell.

Parameters:

  • Row : long - Row number
  • Column : long - Column number
  • Data: Value to set the cell to

SortByColumn (long Column)

Sets the column to sort by.

Returns FALSE if it cannot sort by the specified column.

Parameters:

  • Column: Long - Column number