Represents a Project Navigator item.
typedef struct { GS::uchar_t uName[API_UniLongNameLen]; GS::uchar_t uAutoTextedName[API_UniLongNameLen]; char uiId[128]; API_Guid guid; API_DatabaseInfo db; short floorNum; short vType; API_CutPlanePlanConn intendedPlanConn; API_Guid camId; API_NavigatorMapID mapId; API_NavigatorItemTypeID itemType; API_Guid sourceGuid; Int32 owner; bool customName; bool customUiId; bool filler_2; bool isIndependent; Int32 filler_3[6]; } API_NavigatorItem;
Members
- name
- The name of the navigator item.
- autoTextedName
- The name of the navigator item, in its original form (containing autotexts).
- uiId
- The ID of the navigator item.
- guid
- The own GUID of the navigator item
- db
- The database reference of the the navigator item.
- floorNum
- Floor index the navigator item refers to. Valid only if the type of the database is floorplan [
itemType
is API_StoryNavItem]. - vType
- For internal use.
- intendedPlanConn
- The status of the link between the navigator item and the Floor Plan
- camId
- GUID of a single camera [
itemType
is API_CameraNavItem] or a camera set [itemType
is API_CameraNavItem]. - mapId
- The Project Navigator map wich contains this item.
- itemType
- Type of the item.
- sourceGuid
- The guid of the source navigator item. For example a View item can be the source of a Drawing or a PublisherSet item.
- owner
- The member ID of the item’s owner in TeamWork mode (relevant only in View Map).
- customName
- Custom name of the item (relevant only in the View Map and Layout Map).
- customUiId
- Custom ID of the item (relevant only in the View Map and Layout Map).
- isIndependent
- True when the navigator item is independent.
Remarks
This structure holds the data of an item of the Project Navigator.
The structure is used with the APINavigator_GetNavigatorItemID, APINavigator_GetNavigatorParentItemID, APINavigator_GetNavigatorChildrenItemsID, APINavigator_SearchNavigatorItemID and APINavigator_ChangeNavigatorItemID environment functions.
Requirements
- Version: API 4.3 or later
- Header: APIdefs_Navigator.h
See Also
API_DatabaseInfo, API_NavigatorMapID, API_NavigatorItemTypeID
API_NavigatorSet, API_NavigatorView
APINavigator_GetNavigatorItemID, APINavigator_SearchNavigatorItemID, APINavigator_ChangeNavigatorItemID
API Types