GetHolTextFromTable

Navigation:  Macros > Macro Language > Built-in Functions > All Functions (Alphabetical) >

GetHolTextFromTable

Previous pageReturn to chapter overviewNext page

str = GetHolTextFromTable(bFullText)

 

This macro function returns the plain text part of the current holiday in the holidays table.

meaning of bFullText

meaning of bFullText

 

The current holiday in the holidays table is due to previous calls to functions which move the cursor in the holidays table, such as FindNextHolidayOnDate and GetNextDateForHolidayId.

 

The parameter bFullText specifies if you also want the text of the holiday name variations (bFullText = true) or just the text of the first line of the holiday name (bFullText = false).

 

In the example on the right, calling GetHolTextFromTable(false) would return "Christmas Day" only, but calling GetHolTextFromTable(true) would also include the name variations, including the >>>.

 

The macro code below checks if the current holiday in the holidays table contains any name variations for days in lieu.

sText = GetHolTextFromTable(false)
if pos('DUP=', sText) > 0 
   bHasDayInLieuVariations = true
endif

If you need to get the formatted text of a holiday name, with bold italic etc... attributes, then you should use the GetHolNameFromTable function instead.

 

Se also: GetHolTextOverrideFromTable.


Topic 110054 updated on 16-Feb-2019.
Topic URL: https://www.qppstudio.net/webhelp_xe3/index.html?getholidaytext.htm