Ops |
This class provides information about the current check and the
current state of OPS. Also provided is environmental information
such a property, workstation and revenue center parameters, as
well as methods to execute operational commands and display dialogs.
This class is intended primarily for UI binding and extensibility.
Inheritance HierarchySystemObject
Micros.OpsOpsContext
Micros.OpsOpsContext
Namespace: Micros.Ops
Assembly: Ops (in Ops.dll) Version: 19.8
SyntaxC#
public class OpsContext : INotifyPropertyChanged, IOpsContextProvider, IBulkNotifyPropertiesChanged
The OpsContext type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveCachedPrefixLevelOverride | The active cached prefix menu level override value. |
| ActiveSeat | The currently active seat that will be used on the next ordered parent |
| ActivityLog | Activity Log |
| AlertContext | |
| AlwaysHideFrame | |
| AmountDueHeader | The title of the column showing the amount due when displaying a list of open checks. |
| AuthenticationStatus | The Ops Authentication Status returned from the ServiceAuthenticator |
| AutoServiceChargeDescriptor | The text to be used as a label when displaying the auto service charge. |
| AvailableMemory | Available memory in system |
| BackupPrinterNum | Backup Printer Number |
| BanquetCheckPrinterNum | Laser Printer Number |
| BatteryLifePercent | |
| Blank | Returns blank (for blank binding purposes such as the status bar) |
| CALUrl | |
| CanPickupOtherEmployeesChecks | |
| CAPSConnectionStatus | This element will display offline or online depending on whether the workstation can communicate with CAPS. |
| CashManagementInfo | |
| ChangeDueDescriptor | The text to be used as a label when displaying the change due to the customer. |
| Check | The current check header if a check is open. |
| CheckActive | True if there is a currently active guest check. |
| CheckAutoServiceCharge | Total Auto Service Charges that have been applied to the currently active check. |
| CheckAutoServiceChargeZero | True if Total Auto Service Charges that have been applied to the currently active check is not zero. |
| CheckChangeDue | The change to be given to the customer after all all items, charges, taxes and payments have been totalized. |
| CheckChangeDueZero | True if The change due on the currently active check is not zero. |
| CheckClosed | Is the check closed or not. |
| CheckContext | Check data |
| CheckCurrencySymbol | The symbol of the currency currently being used by OPS. |
| CheckCurrencySymbolOnRight | The position of the symbol of the currency currently being used by Ops |
| CheckCurrentEventActualStartDateTime | Actual start date/time of any group event associated with the current check. |
| CheckCurrentEventEndDateTime | Scheduled end date/time of any group event associated with the current check. |
| CheckCurrentEventExternalEventID | External Event ID of any group event associated with the current check. |
| CheckCurrentEventName | Name of any group event associated with the current check. |
| CheckCurrentEventShortCode | Short code of any group event associated with the current check. |
| CheckDetail | The current check detail if a check is open. |
| CheckDiscount | Total discounts that have been applied to the currently active check. |
| CheckDiscountZero | True if Total discounts that have been applied to the currently active check is not zero. |
| CheckEmployeeCheckName | The name of the employee that picked up or began the check. |
| CheckGroup | The group number if this check is assigned to a table and there are multiple groups at the table. |
| CheckGuestCount | The number of guests assigned to the check. |
| CheckGuestCountIdentification | Guest count identification. The format is "GST # if count not 0, blank otherwise. FPS-48748 | pgkumari | Modified the CheckGuestCountIdentification to now display as GST 0 even when the count is 0 |
| CheckGuestCountText | The number of guests assigned to the check. |
| CheckHeaderLines | Return check standard header lines which max line equals 6 |
| CheckHeaderLinesCount | Return Check Header Lines' Count |
| CheckIdHeader | The title of the column showing the check Id when displaying a list of open checks. |
| CheckInclTaxExempt | Total of inclusive tax exemption that has been applied on the currently active check. |
| CheckInclTaxExemptZero | True if Total of inclusive tax exemption applied to the currently active check is not zero. |
| CheckIsOpen | Indicates if a check is currently open. |
| CheckName | Name of the currently active guest check if a name was assigned to the check. |
| CheckNameHeader | The title of the column showing the check name due when displaying a list of open checks. |
| CheckNumber | Number of the currently active guest check. |
| CheckNumberHeader | The title of the column showing the check number when displaying a list of open checks. |
| CheckNumberText | Number of the currently active guest check as a string. Returns an empty string if there is no check active. |
| CheckOpenedToday | |
| CheckOpenHeader | The title of the column showing the amount due when displaying a list of open checks. |
| CheckOpenTime | The time the check was begun. |
| CheckOpenTimeFormatted | The date time the check was begun formatted for SuperLite |
| CheckOrderTypeText | |
| CheckOther | Total of other charges that have been applied to the currently active check. |
| CheckOtherZero | True if Total of other charges that have been applied to the currently active check is not zero. |
| CheckPayment | Total payments that have been applied to the currently active check. |
| CheckPaymentZero | True if Total payments that have been applied to the currently active check is not zero. |
| CheckRush | Has the check Rush items or not. |
| CheckSubtotal | Subtotal of the items on the currently active check. |
| CheckSubtotalZero | True if Subtotal of the items on the currently active check is not zero. |
| CheckSummaryDataList | A list of check summary information for all open checks. |
| CheckTableAndGroupText | Check Table Text And Group in format "TBL {TableTextAndGroup}" Where {TableTextAndGroup} = The "table number/group" if non-blank and table number is used. if table is 0 then blank is returned. The "table name/group" if non-blank and table name is used. if table is 0 then blank is returned. |
| CheckTableName | The table name if this check is assigned to a table. |
| CheckTableNumber | The table number if this check is assigned to a table. |
| CheckTax | Total tax that has been applied to the currently active check. |
| CheckTaxZero | True if Total tax that has been applied to the currently active check is not zero. |
| CheckTotalDue | The total due on the currently active check. This is the sum of all items, charges, taxes and payments. |
| CheckTotalDueCurrency | The total due on the currently active check. This is the sum of all items, charges, taxes and payments in current displayed currency |
| CheckTotalDueRoundedUp | The total due on the currently active check rounded up to the nearest whole currency unit. |
| CheckTotalDueRoundedUpCurrency | The total due on the currently active check rounded up to the nearest whole currency unit in current displayed currency. |
| CheckTotalDueZero | True if The total due on the currently active check is not zero. This is the sum of all items, charges, taxes and payments. |
| CheckTrailerLines | Return check standard trailer lines |
| CheckTrailerLinesCount | Return Check Trailer Lines' Count |
| CheckTraining | Is the check training check or not. |
| CheckVip | Is the check VIP or not. |
| ClearScreenAfterTransaction | |
| ClickCount | For internal use only. |
| ClosedCheckEmployees | A unique list of employees that exist in the current filtered set of closed checks. |
| ClosedCheckFilter | Data used to filter ClosedCheckSummaryDataList |
| ClosedCheckSummaryDataList | A list of check summary information for closed checks. |
| ComboMealSidePrompt | Combo Meal Side Prompt |
| ComboSideDefaultLevelActive | Will be set to true if a combo side has a default menu level. This is intended for use with the menu level keys so the user can use the button to temporarily change the menu level (so small drinks appear in the SLU instead of large drinks). |
| CommandLog | A list of CommandLogEntries |
| Company | Company. |
| ConnectionStatusIsOnline | TRUE if the connection status is online. FALSE if we are Offline or OfflineWithoutPermission. |
| ConnectionStatusText | Text describing the current communications status. |
| Container | The object that contains this OpsContext instance. |
| Copyright | Copyright. |
| CurbsideCheckActive | True if there is a currently active curbside guest check. |
| CurrencySymbolOnRight | True if the currency decimal character is on the right side of the total |
| CurrencyUseThousandSeparator | True if the base currency uses thousand separator character. |
| CurrentBaseCurrencyDp | The number of decimal places to be displayed when displaying currency amounts. |
| CurrentBaseCurrencyID | The ID of the base currency |
| CurrentChildItem | Number of the currently selected child item on the check. |
| CurrentChildsParentItem | Number of the parent of the currently selected child item on the check. If a condiment of a Combo meal side is selected, the condiments parent is the Combo Meal side (not the Combo Meal parent). |
| CurrentCultureInfo | Identifier of the current culture |
| CurrentCurrencyDp | The number of decimal places to be displayed when displaying currency amounts for current displayed currency. |
| CurrentCurrencySymbol | The symbol of the currency currently being displayed. |
| CurrentDateTextForSuperLite | The current date as string. eg. Wednesday, October 01, 2008 |
| CurrentDateTime | The current date and time. |
| CurrentDateTimeText | The current date and time as a long string. eg. 1/3/2002 12:00:00 AM |
| CurrentDateTimeTextForSuperLite | The current date and time as a long string. eg. 1/3/2002 12:00 AM |
| CurrentDecimalSeparator | The decimal separator currently used by OPS when displaying currencies. |
| CurrentDisplayedCurrencyID | The Currency ID of the current displayed currency |
| CurrentLangId | Identifier of the current language id being used by OPS. |
| CurrentLangObjNum | Identifier of the current language object number being used by OPS. |
| CurrentLocaleId | Identifier of the current locale Id being used by OPS |
| CurrentLocaleInfoPrint | |
| CurrentLongDateTimeText | The current date and time as a long string. eg. Thursday, January 03, 2002 12:00:00 AM |
| CurrentLongDateTimeTextForSuperLite | The current date and time as a long string. eg. Thursday, January 03, 2002 12:00 AM |
| CurrentOrderConfirmationBoard | The Current Order Confirmation Board which displays data. |
| CurrentParentItem | Number of the currently selected parent item on the check. |
| CurrentParentItemAnonymous | True if the current parent item is anonymous. |
| CurrentParentItemCount | Number of parent items on the currently active check. |
| CurrentParentItemName | The name of the currently selected parent item. |
| CurrentParentItemValid | True if the CurrentParentItem is a valid parent item. |
| CurrentParentItemWithCondiments | The name of the currently selected parent item and it's condiments. |
| CurrentPrintLocaleId | Identifier of the current locale id of print being used by OPS |
| CurrentThousandSeparator | The thousand separator currently used by OPS when displaying currencies. |
| CurrentTimeText | The current time as a string. eg. 12:00 AM |
| CursorOn | Get the cursor settings from the db. |
| DataStore | Obsolete. Please do not use this Property. Use the DataStore instead. |
| DataStoreConnectionStatusIsOnline | Obsolete. TRUE if the DataStore connection status is online. FALSE if we are Offline. |
| DataStoreConnectionStatusText | Obsolete. Text describing the current DataStore communication status with central server. |
| DefaultKeyboardState | This bool is used to check if the default alpha-numeric keyboard is being used. |
| DeliveryCheckActive | True if there is a currently active delivery guest check. |
| DeliveryTakeoutInfo | |
| DiscountDescriptor | The text to be used as a label when displaying the check's Discount total. |
| DiscountEngineLog | Discount Engine Log |
| DisplayDetail | Provided DisplayDetail Property, Only copy required data from sorted check detail to DisplayDetailList list object of ExtensibilityOpsDisplayDetailClass. DisplayDetailList will be expose to Starbux.py for PrintLabel Job. |
| DisplayType | The display type of the workstation |
| DTOCheckActive | True if there is a currently active takeout, curbside or delivery guest check. |
| EGatewayURL | EGateway URL |
| EmployeeHeader | The title of the column showing the owning employee when displaying a list of open checks. |
| EmployeeSignedIn | Flag indicating if an employee is signed in |
| EmplSession | The employee session data if an employee is signed in. |
| EndorsementPrinterNum | Endorsement Printer Number |
| EnterpriseConnectionStatus | Obsolete. This element will display offline or online depending on whether the workstation can communicate with the Enterprise. |
| EntryArea | Contains entered information such as keyboard entry. On the sign in screen this field will be masked. |
| EntryAreaValue | Contains entry area information as a decimal entry. Will be null if entry area is invalid decimal entry OR entry area is blank. |
| ErrorBeeperEnabled | True if the error beeper has been enabled for this workstation. |
| ExtensibilityState | |
| FlowDirection | |
| FullCheckSummaryDataList | A list of check summary information for all open checks. |
| GiftCardTransactionItem | Return true if an SPI gift card service charge has been added |
| GuestCheckPrinterNum | Guest Check Printer Number |
| HasAllowedCondiments | |
| HasRequiredCondiments | |
| HoldIndicator | Contains status text of the 'Hold Status' for 'Hold Indicator' status bar. |
| HoldIndicatorFlag | Contains status of the 'Hold Status' as a boolean value specially for mobile devices. |
| HoldState | |
| HostName | Gets the programmed HostName for this servicehost. |
| InclTaxExemptDescriptor | FPS-114588 | FPPRT-60 | PARTCHAT | The text to be used as a label when displaying the check's Inclusive Tax Exemption total. |
| InEqualPaymentMode | The currently active check is in equal payment mode. |
| Initialized | Returns true if this OpsContext instance has been initialized. |
| IPaddress | Get IP Address of OPS. |
| IsAndroid | |
| IsCastleWorkstation | |
| IsCurrentCurrencyBase | True if the current displayed currency is the base currency. |
| IsFastTransaction | Return true if fast transaction check Otherwise a guest check |
| IsHHT | Is Hand helds |
| IsOpiConfigured | True if OPI or SPI is configured. |
| IsRTL | |
| IsTouchSplitCheckPage | - Getter or Setter to know if CheckDetailArea2.xaml.cs is called from TouchSplit Command or not since CheckDetailArea2.xaml.cs can be called from ViewCheckDetail Command as well - is set to true in Operations.Check.SplitCheck.cs |
| IsVoidOrReturnTransaction | Return true if check started in void or return mode |
| KdsOrderDestination | This element will display which KDS Controller (the Primary or the Backup) the current Revenue Center is sending Order to. |
| KeyBeeperEnabled | True if the keyboard beeper has been enabled for this workstation. |
| KitchenThemeName | The name of the current kitchen theme. |
| LastAction | Contains text indicating the last action performed by the system. |
| LastCachedPrefixLevelOrderide | |
| LastEntryArea | Displays the lastest action performed by the system or entered information such as keyboard entry. |
| LastEntryAreaIsEntryArea | True if the LastEntryArea is EntryArea, false otherwise. |
| LastPageNumber | |
| LastShowPricing | |
| LaunchKDSDisplay | |
| LegacyPOSThemeActive | |
| LocalOrderPrinterNum | Local Order Printer Number |
| LocationFromLeft | |
| LocationFromTop | |
| LocationId | Location id. Returns the Location id associated with this workstation. If none is found due to improper configuration then a -1 is returned. |
| LocRef | Location Ref. Returns the Location Ref associated with this workstation. If none is found due to improper configuration then empty string is returned. |
| MainMenuLevel | The main menu level. |
| MainMenuLevelIndex | The main menu level index. |
| MaxDialogResolutionColumns | The max number of screen resolution columns a dialog should be. |
| MaxDialogResolutionRows | The max number of screen resolution columns a dialog should be. |
| MemoCheckPrinterNum | Memo Check Printer Number |
| MenuItemOrdererLog | Menu Item Orderer Log |
| MenuItemSummaryData | A list of Menu Item Summary entries. |
| MenuLevel | A dictionary of active menu levels. |
| Networking | Networking access. |
| NotificationArea | Contains notification for the user. |
| NotificationContext | |
| NTEPCC | National Turfgrass Evaluation Program Certificates of Conformance. |
| ObjectPropertyBag | Property bag containing objects for use in this context. |
| OldOpenCheckMessage | Message containing the number of open checks from previous business days. |
| OperaPMSExtName | |
| OperatingSystem | Operating System |
| OperatorCurrentEventActualStartDateTime | Actual start date/time of any operator assigned group event. |
| OperatorCurrentEventEndDateTime | Scheduled end date/time of any operator assigned group event. |
| OperatorCurrentEventExternalEventID | External Event ID of any operator assigned group event. |
| OperatorCurrentEventName | Name of any operator assigned group event. |
| OperatorCurrentEventShortCode | Short code of any operator assigned group event. |
| OpsTranslatedText | Translated text for Ops in the current language on the workstation. |
| OpsTranslatedTextWs | Translated text for Ops in the default language as configured for the workstation. |
| OrderChannelName | The name of the order channel assigned to the check. |
| OrderChannelNumber | The order channel assigned to the check. |
| OrderMethodName | The name of the order method assigned to the check. |
| OrderStatusID | The order status assigned to the check. |
| OrderStatusName | The name of the order status assigned to the check. |
| OrderTypeName | The name of the order type assigned to the check. |
| OrderTypeNumber | The order type assigned to the check. |
| OrganizationId | Organization id. Returns the organization id associated with this workstation. If none is found due to improper configuration then a -1 is returned. |
| OtherDescriptor | The text to be used as a label when displaying the check's Other total. |
| PageID | Current page database ID |
| PageNumber | Current page database object number |
| PageTemplateID | Database ID of currrent page template displayed |
| PaymentDescriptor | The text to be used as a label when displaying the check's Payments total. |
| Platform | Platform |
| PlaybackInProgress | Indicates if the OPS autotest playback is in progress |
| PosCoreTranslatedText | Translated text for PosCore in the current language on the workstation. |
| PosCoreTranslatedTextWs | Translated text for PosCore in the default language as configured for the workstation. |
| PowerStatus | Returns the battery status if present. |
| PrimaryCheckIdentification | Check name if not blank, tabletext/group if not blank, otherwise check number |
| ProcessingDialog | True if an Ops dialog is displaying or in process of being displayed. |
| Product | Product. |
| PromptArea | Displays text prompting the user to perform some action. |
| PropertyBag | Property bag containing string for use in this context. |
| PropertyID | The property id. |
| PropertyName | The name of the property where this workstation resides. |
| PropertyNumber | The unique number of the property where this workstation resides. |
| PropHierStrucID | The property hierarchy structure ID. |
| ReceiptPrinterNum | Receipt Printer Number |
| ReceptacleBalancingItemID | |
| RemainingComboSideCount | Remaining Combo Meal Side Count |
| RemoteSupportActive | Returns whether a remote support session is active. Should only be true for Linux at present. |
| RemoteSupportStatusText | Returns whether a remote support session is active. Should only be true for Linux at present. |
| ReportPrinterNum | Report Printer Number |
| ResetDTODashboard | |
| ResolutionColumns | The number of screen resolution columns configured for this workstation. |
| ResolutionRows | The number of screen resolution rows configured for this workstation. |
| ReturnEnabled | The currently active check is in the "return" state. |
| ReturnText | This field indicates the "return" state of the currently active check. |
| RvcID | The unique ID of the current revenue center. |
| RvcName | The name of the current revenue center. |
| RvcNumber | The unique number of the current revenue center. |
| RvcNumberText | The unique text of the current revenue center (blank if not set) |
| ScreenLanguageFontFamily | The font family of the current screen language. Default to Courier New. |
| ScreenLanguageFontSize | The font size of the current screen language. Default to 12. |
| SeatPlating | The "SeatPlating" state. |
| SecondaryCheckIdentification | Tabletext/group if check name not blank, otherwise check number |
| SelectedCheckAutoServiceCharge | |
| SelectedCheckAutoServiceChargeZero | |
| SelectedCheckDiscount | |
| SelectedCheckDiscountZero | |
| SelectedCheckInclTaxExempt | |
| SelectedCheckInclTaxExemptZero | |
| SelectedCheckOpenedToday | |
| SelectedCheckOpenTimeFormatted | |
| SelectedCheckOther | |
| SelectedCheckOtherZero | |
| SelectedCheckPayment | |
| SelectedCheckPaymentZero | |
| SelectedCheckSortedDetail | |
| SelectedCheckSubTotal | |
| SelectedCheckTableNumber | |
| SelectedCheckTax | |
| SelectedCheckTaxZero | |
| SelectedCheckTotalDue | |
| SelectedCheckTraining | |
| SelectedCheckVip | |
| SelectedPrimaryCheckIdentification | |
| SelectedSuperLiteCheckGuid | Variable to hold selkected Check Guid from SuperLite Home screen so we can get it's detail to display in the Receipt Detail Area without 'opening' the check. |
| ServingPeriod | The current serving period. |
| ServingPeriodId | The current serving period. |
| ServingPeriodNumber | The current serving period number. |
| ShowCALUrl | Set to false if TimsInfoKey is Pressed at SignIn. True by default for System Information Panel |
| ShowCheckSummaryArea | True if Total tax that has been applied to the currently active check is not zero. |
| ShowEmployee | Set to false if Employee ID is zero |
| ShowIPAddress | Set to false if TimsInfoKey is Pressed at SignIn. True by default for System Information Panel |
| ShowKDSButtons | Show KDS buttons only if KDS is configured |
| ShowOrderChannel | True if Option bit 65 enabled in Format parameters |
| SortedDetail | The sorted check detail for the current check. |
| StartTime | Time that OPS was started. |
| StartTimeText | Time that OPS was started as a long date and time string. |
| StartTimeTextForSuperLite | Time that OPS was started as a long date and time string. eg. Thursday, January 03, 2002 12:00 AM |
| SubMenuLevel | The sub menu level. |
| SubMenuLevelIndex | The sub menu level index. |
| SubtotalDescriptor | The text to be used as a label when displaying the check's Subtotal. |
| SuperLiteCheckTableNumber | Return either CheckTableNumber or CheckTableName for Simphony Essentials based on RVC Parameter Option Bit 18 |
| SuperLiteCompany | Company, superLite style. |
| SuperLiteCurrentCheckMode | Displays the current Hold/Void/Return Mode for the check. |
| SuperLiteCurrentCheckSortOrder | Return sort order for checks on home screen |
| SuperLiteProduct | Product, superLite style. |
| SuperLiteShowClockInButtons | Flag to indicate if Clock In buttons should be displayed. |
| SuperLiteSystemInfoIPAddress | |
| TableNameHeader | The title of the column showing the table name/group number when displaying a list of open check |
| TableTextAndGroup | The table name/group if non-blank, otherwise the table number. if table is 0 then blank is returned. |
| TakeoutCheckActive | True if there is a currently active takeout guest check. |
| TaxDescriptor | The text to be used as a label when displaying the check's Tax total. |
| TaxExemptEnabled | The check is exempt from taxes. |
| TaxExemptText | The reason the check is exempt from taxes. |
| TertiaryCheckIdentification | Check number if check name and table not blank. |
| TillAssignedToWorkstation | Will be set to true if a till is assigned to any of the workstations cash drawers. |
| TimeCardPrinterNum | Time Card Printer Number |
| TimeChitPrinterNum | Time Chit Printer Number |
| TotalDueDescriptor | The text to be used as a label when displaying the total due on the check. |
| TotalMemory | Total memory in system |
| TrainingModeEnabled | True if the current transaction is a "Training Mode" transaction. |
| TrainingModeText | Text to be used to indicate that the current transaction is a "Training Mode" transaction. |
| TransactionOrderTypeName | The name of the transaction order type assigned to the check. |
| TransactionOrderTypeNumber | The transaction order type assigned to the check. |
| TransCashierName | Check name of the cashier associated with the currently signed in employee |
| TransCashierNumber | Number of the cashier associated with the currently signed in employee |
| TransEmployeeCheckName | Check name of the currently signed in employee. |
| TransEmployeeClassNumber | Employee class of current employee. |
| TransEmployeeFirstName | First name of the currently signed in employee. |
| TransEmployeeFullName | Last name of the currently signed in employee. |
| TransEmployeeID | ID of the currently signed in employee. |
| TransEmployeeIsInTraining | boolean flag stating if the signed in employee is in training mode or not. |
| TransEmployeeLastName | Last name of the currently signed in employee. |
| TransEmployeeNumber | Number of the currently signed in employee. |
| TransReturnEnabled | The currently active check is in the "transaction return" state. |
| TransReturnText | This field indicates the "transaction return" state of the currently active check. |
| TransVoidEnabled | The currently active check is in the "transaction void" state. |
| TransVoidReasonIdValue | The reason id value for a transaction void that is being performed. |
| TransVoidText | The reason a transaction void is being performed. |
| UnmaskedEntryArea | Contains entered information such as keyboard entry. |
| UnsentCheckMessage | Message containing the number of unsent checks. |
| Uptime | The period of time since OPS was last started. |
| UptimeText | The period of time since OPS was last started as a formatted string. |
| UsedMemory | Used memory in system |
| ValidationPrinterNum | Validation Printer Number |
| Version | Current version of OPS. |
| ViewByCourse | The currently active check is in the "ViewByCourse" state. |
| ViewByFamilyGroup | The currently active check is in the "ViewByFamilyGroup" state. |
| ViewByItemEntry | The currently active check is in the "ViewByItemEntry" state. |
| ViewByMajorGroup | The currently active check is in the "ViewByMajorGroup" state. |
| ViewBySeat | The currently active check is in the "ViewBySeat" state. |
| ViewFireTimes | The currently active check is in the "ViewFireTimes" state. |
| VisualState | The current visual state. |
| VoidEnabled | The currently active check is in the "void" state. |
| VoidText | This field indicates the "void" state of the currently active check. |
| VoucherPrinterNum | Voucher Printer Number |
| WirelessQuality | |
| WorkstationClass | The unique number of this workstation. |
| WorkstationID | The unique ID of this workstation. |
| WorkstationLockStatus | The Lock/Unlock status of the of the current workstation. |
| WorkstationName | The name of the of the current workstation. |
| WorkstationNumber | The unique number of this workstation. |
Methods| Name | Description | |
|---|---|---|
 | AskQuestion | Displays a dialog box requesting asked a yes/no question. |
| CalculateTotals | Calculates check totals. This method is computationally intensive and should only be used when absolutely required. |
| CameraScanBarcodeClose | Closes the camera on an Android device if a call to CameraScanBarCodeOpen didn't close |
| CameraScanBarcodeOpen | Opens the camera on an Android device to allow scanning of a barcode |
| ChangeCheckOwner(CGwDruid, Int64) | Change the owner of a close check if we have an active list - call when a closed check is moved to/from another workstation. |
| ChangeCheckOwner(String, Int64) | Change the owner of a close check if we have an active list - call when a closed check is moved to/from another workstation. |
| ClearCommandLog | Clear the command log |
| ClearOpsCheckPreviousData | |
| CloseCurrentRequest | Close the currently processing OpsCommand. |
| ConvertAmountToBaseCurrency | Convert the input amount to amount in base currency. |
| ConvertAmountToForeignCurrency | Convert the input amount to amount in current displayed foreign currency. |
| ConvertToBaseCurrencyString | Convert the input amount to amount in base currency and format as string value. |
| ConvertToForeignCurrencyString | Convert the input amount to amount in current displayed foreign currency and format as string value. |
| CreateSVStandSheetItem | |
| CurrencyToString | Format as string value using supplied decimal places. |
| EndProgressRequest | Call when a progress request is active. Closes progress request. |
| FindItemByDetailLink | |
| GeneratePageControlStartUrl | |
| GetBusinessDateTime(FinancialCalendarData) | Obsolete. Gets the current business date and time given the financial calendar |
| GetBusinessDateTime(FinancialCalendarData) | |
| GetCashManagementRevenueCenterSelection | |
| GetCheckSubtotalAsDecimal | Retrieves the CheckSubtotal as a decimal number. |
| GetCheckTaxAsDecimal | Retrieves the CheckTax as a decimal number. |
| GetClosedCheckEmployees | Get a list of employees with checks closed in the period since the specified start time. |
| GetCondimentGroupStatus | |
| GetConfigurationValue | Get configuration value. |
| GetCurrentParentMenuItem | |
| GetDrawerCashAmount | Get how much cash is in the till that currently assigned to the selected drawer |
| GetEmployeeClockInformation | |
| GetFlattenedCheckDetail | |
| GetGuestCheckImage | Extensibility hook for Belgium Guest Check |
| GetItemCondimentSalesCount | |
| GetJournalGuestCheckImage | Get a Guest Check image that is formatted for the Journal. |
| GetLoyaltyModuleData | |
| GetOpsContext | Get the current OPS context instance. |
| GetOutstandingDeposits | |
| GetRVCPaymentStoreId | |
| GetSelectedMenuItem | |
| GetStoredValueModuleData | |
| GetSuspendedChecks | Returns a list of suspended checks |
| ImageSelectionRequest | Image Selection request. Displays a prompt listing the supplied Selection Entries (Image followed by Namwe). Returns index of selected item or null if user cancelled request. |
| InvokeOnCommandThread | Execute delegate on command thread. |
| IsCachedPrefix | |
| IsCondimentOnParent(Int32, Int32) | Checks if a particular condiment has been added to the currently select parent item. |
| IsCondimentOnParent(MenuItemCommandData, Int32) | Checks if a particular condiment has been added to the currently select parent item. |
 | IsTimerProperty | Checks if a property is a Timer Property |
| LaunchBrowserForCustomHTMLPageControl | FPS-111563 HTML Custom page control | Adding support for arguments on Page Control URL in debug mode |
| LogException | Logs exception |
| LogLocalExtensionApplicationMessage | |
| MapRootPath | Get root path. |
| MoveFiscalData | Used to move fiscal data from a set of known fiscal table names. These items are replicated as specified by the fiscal developer during the addition of the fiscal data into the fiscal tables. |
| MultiSelectionRequest | Selection request. Displays a prompt listing the supplied Selection Entries. Returns index of selected item or -1 if user cancelled request. |
| NoSaleReasonCodes | |
| ParentQuantity | |
| PrintReceipt | Print a customized guest check or customer receipt to the guest check or customer receipt printer. |
| ProcessCommand | |
| ProcessDTOCommand | Process an operational command. |
| ProcessDTOConfirmOrderCommand | |
| ProcessDTODeliveryCheckSelected | |
| ProcessDTOPayAndPreConfirmOrderCommand | |
| ProcessDTOSelctionChangedCommand | |
| ProcessScannerData | Processes barcode scanner data. |
| QueueCommand | |
| RaiseBrowserDialog(String, String, Object) | |
| RaiseBrowserDialog(String, String, Object, Type) | |
| RegisterPageControlResource | |
| RequestAlphaEntry | Displays a dialog box requesting an alpha/numeric entry. A null will be returned if the user cancelled the operation. |
| RequestAmountEntry(String, String) | Displays a dialog box requesting an decimal value. A null will be returned if the user cancelled the operation. |
| RequestAmountEntry(String, String, NullableDecimal) | Displays a dialog box requesting an decimal value. A null will be returned if the user cancelled the operation. |
| RequestCustomDialog | Displays the content defined in ContentName and makes Data available for the content resourse to bind to. A null will be returned if the user cancelled the operation. |
 | RequestEntry | This method is used to get any kind of user input. |
| RequestNumericEntry(String, String) | Displays a dialog box requesting an long value. A null will be returned if the user cancelled the operation. |
| RequestNumericEntry(String, String, NullableInt64) | Displays a dialog box requesting an long value. A null will be returned if the user cancelled the operation. |
| RequestStringEntry | Displays a dialog box requesting a numeric string value. A null will be returned if the user cancelled the operation. |
| SearchRequest | Search request. Displays a prompt listing the supplied Selection Entries. Returns index of selected item or -1 if user cancelled request. |
| SelectClosedCheckEmployees | Set employees in the closed check employee list as selected. |
| SelectedCourierListUpdated | Determine if the selected courier list has changed or not. |
| SelectedItemQuantity | |
| SelectionRequest(String, String, IEnumerableObject) | Selection request. Displays a prompt listing the supplied strings. Returns index of selected item or null if user cancelled request. |
| SelectionRequest(String, String, IListOpsSelectionEntry) | Selection request. Displays a prompt listing the supplied Selection Entries. Returns index of selected item or null if user cancelled request. |
| SendAsyncPageControlMessage | |
| SendExtensibilityHtmlDialogData | |
| ShowContentDialog | |
| ShowError | Displays a dialog box containing an error message. |
| ShowException | Displays a dialog box containing showing an exception |
| ShowExtensibilityHtmlDialog | |
| ShowMessage | Displays a dialog box containing showing a message. |
| ShowTextList(String, IListString) | Displays a dialog box containing a text box with multiple lines |
| ShowTextList(String, IEnumerable) | |
| ShowUrlDialog | |
| SimCreateSVStandSheetItem | |
| SimRequestAmountEntry | Displays a dialog box requesting an decimal value. The default will be returned if the user cancelled the operation. |
| SimRequestNumericEntry | Displays a dialog box requesting an long value. The default will be returned if the user cancelled the operation. |
| SimSelectionRequest | Selection request. Displays a prompt listing the supplied strings. Returns index of selected item or -1 if user cancelled request. This is used for SIM due to nullable type issues. |
| SPIReadNonPCICard | Extension app access to allow a non-PCI card to be presented on a payment device |
| StartProgressRequest | Displays an asynchronous dialog box showing a title and message. |
| SubmitPrintJob | Submits a data to a POS printer |
| TransferCheckToEmployee | This method is used to transfer a check to an employee. This method is provided for extension applications that need to transfer a check to an employee, and want to do so without overhead of using Commands/Macros needed by the OpsCommandType.AddXferCheck operation. With this method the current employee can transfer a check to another employee. |
| UpdateCourierList | Update Courier List and flag details as changed for DTO Delivery Dispatch screen |
| UpdateCustomerDisplay | Update customer display |
| UpdateDetailSelected | |
| UpdateDynamicContent | Updates any dynamic content on the WPF control |
| UpdateProgressRequest(String) | Call when a progress request is active. Updates the message and increments the progress control by 1. |
| UpdateProgressRequest(String, Int32) | Call when a progress request is active. Updates the message and sets the progress control to the specified count. |
| UpdateSelectedCheckSortedDetail | |
| UpdateStandSheet | |
| UpdateSuperLiteCurrentCheckMode | Determine if check is in hold, return, or void mode and send a relevant string to the browser. Handling also the VIP and Rush modes for KDS in a similar, but different way |
Events| Name | Description | |
|---|---|---|
 | BulkPropertiesChanged | |
| PropertyChanged |
Fields| Name | Description | |
|---|---|---|
 | AutoPickupNextCheck | Default is TRUE so we can ask the first time, also it is TRUE if the user answered "yes" to the "Find Order?" question, FALSE otherwise. SCR 1363: 09/14/2009: default to false so it is not set when tendering a manual check as the 1st operation of the day. |
 | m_EntryAreaChanged | |
| m_LastActionChanged |
See Also