| blob | 59fc8db312182c633d89797c78b4f8ed81f085af |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="PropertiesGet" script:language="StarBasic">
4 REM =======================================================================================================================
5 REM === The Access2Base library is a part of the LibreOffice project. ===
6 REM === Full documentation is available on http://www.access2base.com ===
7 REM =======================================================================================================================
9 Option Explicit
11 REM -----------------------------------------------------------------------------------------------------------------------
12 Public Function getAbsolutePosition(Optional pvObject As Variant) As Boolean
13 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getAbsolutePosition")
15 End Function ' getAbsolutePosition
17 REM -----------------------------------------------------------------------------------------------------------------------
18 Public Function getAllowAdditions(Optional pvObject As Variant) As Boolean
19 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getAllowAdditions")
21 End Function ' getAllowAdditions
23 REM -----------------------------------------------------------------------------------------------------------------------
24 Public Function getAllowDeletions(Optional pvObject As Variant) As Boolean
25 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getAllowDeletions")
27 End Function ' getAllowDeletions
29 REM -----------------------------------------------------------------------------------------------------------------------
30 Public Function getAllowEdits(Optional pvObject As Variant) As Boolean
33 End Function ' getAllowEdits
35 REM -----------------------------------------------------------------------------------------------------------------------
36 Public Function getBackColor(Optional pvObject As Variant) As Variant
39 End Function ' getBackColor
41 REM -----------------------------------------------------------------------------------------------------------------------
42 Public Function getBeginGroup(Optional pvObject As Variant) As Variant
45 End Function ' getBeginGroup
47 REM -----------------------------------------------------------------------------------------------------------------------
48 Public Function getBOF(Optional pvObject As Variant) As Variant
51 End Function ' getBOF
53 REM -----------------------------------------------------------------------------------------------------------------------
54 Public Function getBookmark(Optional pvObject As Variant) As Variant
57 End Function ' getBookmark
59 REM -----------------------------------------------------------------------------------------------------------------------
60 Public Function getBookmarkable(Optional pvObject As Variant) As Variant
61 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getBookmarkable")
63 End Function ' getBookmarkable
65 REM -----------------------------------------------------------------------------------------------------------------------
66 Public Function getBorderColor(Optional pvObject As Variant) As Variant
67 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getBorderColor")
69 End Function ' getBorderColor
71 REM -----------------------------------------------------------------------------------------------------------------------
72 Public Function getBorderStyle(Optional pvObject As Variant) As Variant
73 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getBorderStyle")
75 End Function ' getBorderStyle
77 REM -----------------------------------------------------------------------------------------------------------------------
78 Public Function getBuiltIn(Optional pvObject As Variant) As Boolean
81 End Function ' getBuiltIn
83 REM -----------------------------------------------------------------------------------------------------------------------
84 Public Function getButtonLeft(Optional pvObject As Variant) As Boolean
87 End Function ' getButtonLeft
89 REM -----------------------------------------------------------------------------------------------------------------------
90 Public Function getButtonMiddle(Optional pvObject As Variant) As Boolean
91 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getButtonMiddle")
93 End Function ' getButtonMiddle
95 REM -----------------------------------------------------------------------------------------------------------------------
96 Public Function getButtonRight(Optional pvObject As Variant) As Boolean
97 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getButtonRight")
99 End Function ' getButtonRight
101 REM -----------------------------------------------------------------------------------------------------------------------
102 Public Function getCancel(Optional pvObject As Variant) As Variant
105 End Function ' getCancel
107 REM -----------------------------------------------------------------------------------------------------------------------
108 Public Function getCaption(Optional pvObject As Variant) As Variant
111 End Function ' getCaption
113 REM -----------------------------------------------------------------------------------------------------------------------
114 Public Function getClickCount(Optional pvObject As Variant) As Long
115 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getClickCount")
117 End Function ' getClickCount
119 REM -----------------------------------------------------------------------------------------------------------------------
120 Public Function getContextShortcut(Optional pvObject As Variant) As String
121 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getContextShortcut")
123 End Function ' getContextShortcut
125 REM -----------------------------------------------------------------------------------------------------------------------
126 Public Function getControlSource(Optional pvObject As Variant) As Variant
127 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getControlSource")
129 End Function ' getControlSource
131 REM -----------------------------------------------------------------------------------------------------------------------
132 Public Function getControlTipText(Optional pvObject As Variant) As Variant
133 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getControlTipText")
135 End Function ' getControlTipText
137 REM -----------------------------------------------------------------------------------------------------------------------
138 Public Function getControlType(Optional pvObject As Variant) As Integer
139 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getControlType")
141 End Function ' getControlType
143 REM -----------------------------------------------------------------------------------------------------------------------
144 Public Function getCount(Optional pvObject As Variant) As Integer
147 End Function ' getCount
149 REM -----------------------------------------------------------------------------------------------------------------------
150 Public Function getCurrentRecord(Optional pvObject As Variant) As Variant
151 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getCurrentRecord")
153 End Function ' getCurrentRecord
155 REM -----------------------------------------------------------------------------------------------------------------------
156 Public Function getDataType(Optional pvObject As Variant) As Variant
159 End Function ' getDataType
161 REM -----------------------------------------------------------------------------------------------------------------------
162 Public Function getDbType(Optional pvObject As Variant) As Variant
165 End Function ' getDbType
167 REM -----------------------------------------------------------------------------------------------------------------------
168 Public Function getDefault(Optional pvObject As Variant) As Variant
171 End Function ' getDefault
173 REM -----------------------------------------------------------------------------------------------------------------------
174 Public Function getDefaultValue(Optional pvObject As Variant) As Variant
175 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getDefaultValue")
177 End Function ' getDefaultValue
179 REM -----------------------------------------------------------------------------------------------------------------------
180 Public Function getDescription(Optional pvObject As Variant) As Variant
181 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getDescription")
183 End Function ' getDescription
185 REM -----------------------------------------------------------------------------------------------------------------------
186 Public Function getEditMode(Optional pvObject As Variant) As Variant
189 End Function ' getEditMode
191 REM -----------------------------------------------------------------------------------------------------------------------
192 Public Function getEnabled(Optional pvObject As Variant) As Variant
195 End Function ' getEnabled
197 REM -----------------------------------------------------------------------------------------------------------------------
198 Public Function getEOF(Optional pvObject As Variant) As Variant
201 End Function ' getEOF
203 REM -----------------------------------------------------------------------------------------------------------------------
204 Public Function getEventName(Optional pvObject As Variant) As String
207 End Function ' getEventName
209 REM -----------------------------------------------------------------------------------------------------------------------
210 Public Function getEventType(Optional pvObject As Variant) As String
213 End Function ' getEventType
215 REM -----------------------------------------------------------------------------------------------------------------------
216 Public Function getFieldSize(Optional pvObject As Variant) As Variant
219 End Function ' getFieldSize
221 REM -----------------------------------------------------------------------------------------------------------------------
222 Public Function getFilter(Optional pvObject As Variant) As String
225 End Function ' getFilter
227 REM -----------------------------------------------------------------------------------------------------------------------
228 Public Function getFilterOn(Optional pvObject As Variant) As Boolean
231 End Function ' getFilterOn
233 REM -----------------------------------------------------------------------------------------------------------------------
234 Public Function getFocusChangeTemporary(Optional pvObject As Variant) As Boolean
235 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getFocusChangeTemporary")
236 getFocusChangeTemporary = PropertiesGet._getProperty(pvObject, "FocusChangeTemporary")
237 End Function ' getFocusChangeTemporary
239 REM -----------------------------------------------------------------------------------------------------------------------
240 Public Function getFontBold(Optional pvObject As Variant) As Variant
243 End Function ' getFontBold
245 REM -----------------------------------------------------------------------------------------------------------------------
246 Public Function getFontItalic(Optional pvObject As Variant) As Variant
247 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getFontItalic")
249 End Function ' getFontItalic
251 REM -----------------------------------------------------------------------------------------------------------------------
252 Public Function getFontName(Optional pvObject As Variant) As Variant
255 End Function ' getFontName
257 REM -----------------------------------------------------------------------------------------------------------------------
258 Public Function getFontSize(Optional pvObject As Variant) As Variant
261 End Function ' getFontSize
263 REM -----------------------------------------------------------------------------------------------------------------------
264 Public Function getFontUnderline(Optional pvObject As Variant) As Variant
265 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getFontUnderline")
267 End Function ' getFontUnderline
269 REM -----------------------------------------------------------------------------------------------------------------------
270 Public Function getFontWeight(Optional pvObject As Variant) As Variant
271 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getFontWeight")
273 End Function ' getFontWeight
275 REM -----------------------------------------------------------------------------------------------------------------------
276 Public Function getForm(Optional pvObject As Variant) As Variant ' Return Subform pseudo
279 End Function ' getForm
281 REM -----------------------------------------------------------------------------------------------------------------------
282 Public Function getFormat(Optional pvObject As Variant) As Variant
285 End Function ' getFormat
287 REM -----------------------------------------------------------------------------------------------------------------------
288 Public Function getHeight(Optional pvObject As Variant) As Long
291 End Function ' getHeight
293 REM -----------------------------------------------------------------------------------------------------------------------
294 Public Function getForeColor(Optional pvObject As Variant) As Variant
297 End Function ' getForeColor
299 REM -----------------------------------------------------------------------------------------------------------------------
300 Public Function getIsLoaded(Optional pvObject As Variant) As Boolean
303 End Function ' getIsLoaded
305 REM -----------------------------------------------------------------------------------------------------------------------
306 Public Function getItemData(Optional pvObject As Variant, ByVal Optional pvIndex As Variant) As Variant
308 If IsMissing(pvIndex) Then
310 Else
312 End If
313 End Function ' getItemData
315 REM -----------------------------------------------------------------------------------------------------------------------
316 Public Function getKeyAlt(Optional pvObject As Variant) As Boolean
319 End Function ' getKeyAlt
321 REM -----------------------------------------------------------------------------------------------------------------------
322 Public Function getKeyChar(Optional pvObject As Variant) As String
325 End Function ' getKeyChar
327 REM -----------------------------------------------------------------------------------------------------------------------
328 Public Function getKeyCode(Optional pvObject As Variant) As Integer
331 End Function ' getKeyCode
333 REM -----------------------------------------------------------------------------------------------------------------------
334 Public Function getKeyCtrl(Optional pvObject As Variant) As Boolean
337 End Function ' getKeyCtrl
339 REM -----------------------------------------------------------------------------------------------------------------------
340 Public Function getKeyFunction(Optional pvObject As Variant) As Integer
341 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getKeyFunction")
343 End Function ' getKeyFunction
345 REM -----------------------------------------------------------------------------------------------------------------------
346 Public Function getKeyShift(pvObject As Variant) As Boolean
349 End Function ' getKeyShift
351 REM -----------------------------------------------------------------------------------------------------------------------
352 Public Function getLinkChildFields(Optional pvObject As Variant, ByVal Optional pvIndex As Variant) As Variant
353 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getLinkChildFields")
354 If IsMissing(pvObject) Then
356 Else
358 End If
359 End Function ' getLinkChildFields
361 REM -----------------------------------------------------------------------------------------------------------------------
362 Public Function getLinkMasterFields(Optional pvObject As Variant, ByVal Optional pvIndex As Variant) As Variant
363 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getLinkMasterFields")
364 If IsMissing(pvIndex) Then
366 Else
367 getLinkMasterFields = PropertiesGet._getProperty(pvObject, "LinkMasterFields", pvIndex)
368 End If
369 End Function ' getLinkMasterFields
371 REM -----------------------------------------------------------------------------------------------------------------------
372 Public Function getListCount(Optional pvObject As Variant) As Variant
375 End Function ' getListCount
377 REM -----------------------------------------------------------------------------------------------------------------------
378 Public Function getListIndex(Optional pvObject As Variant) As Variant
381 End Function ' getListIndex
383 REM -----------------------------------------------------------------------------------------------------------------------
384 Public Function getLocked(Optional pvObject As Variant) As Variant
387 End Function ' getLocked
389 REM -----------------------------------------------------------------------------------------------------------------------
390 Public Function getMultiSelect(Optional pvObject As Variant) As Variant
391 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getMultiSelect")
393 End Function ' getMultiSelect
395 REM -----------------------------------------------------------------------------------------------------------------------
396 Public Function getName(Optional pvObject As Variant) As String
399 End Function ' getName
401 REM -----------------------------------------------------------------------------------------------------------------------
402 Public Function getObjectType(Optional pvObject As Variant) As String
403 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getObjectType")
405 End Function ' getObjectType
407 REM -----------------------------------------------------------------------------------------------------------------------
408 Public Function getOpenArgs(Optional pvObject As Variant) As String
411 End Function ' getOpenArgs
413 REM -----------------------------------------------------------------------------------------------------------------------
414 Public Function getOptionGroup(Optional pvObject As Variant, pvName As variant) As Variant
415 ' Return an OptionGroup object based on its name
418 If IsMissing(pvObject) Or IsMissing(pvName) Then Call _TraceArguments()
419 If _ErrorHandler() Then On Local Error Goto Error_Function
421 If Not Utils._CheckArgument(pvObject, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
422 If Not Utils._CheckArgument(pvName, 2, vbString) Then Goto Exit_Function
424 getOptionGroup = pvObject.OptionGroup(pvName)
426 Exit_Function:
428 Exit Function
429 Error_Function:
431 GoTo Exit_Function
434 REM -----------------------------------------------------------------------------------------------------------------------
435 Public Function getOptionValue(Optional pvObject As Variant) As String
436 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getOptionValue")
438 End Function ' getOptionValue
440 REM -----------------------------------------------------------------------------------------------------------------------
441 Public Function getOrderBy(Optional pvObject As Variant) As String
444 End Function ' getOrderBy
446 REM -----------------------------------------------------------------------------------------------------------------------
447 Public Function getOrderByOn(Optional pvObject As Variant) As Boolean
450 End Function ' getOrderByOn
452 REM -----------------------------------------------------------------------------------------------------------------------
453 Public Function getPage(Optional pvObject As Variant) As String
458 REM -----------------------------------------------------------------------------------------------------------------------
459 Public Function getParent(Optional pvObject As Variant) As String
464 REM -----------------------------------------------------------------------------------------------------------------------
465 Public Function getProperty(Optional pvItem As Variant, Optional ByVal pvProperty As Variant, ByVal Optional pvIndex As Variant) As Variant
466 ' Return property value of object pvItem, and psProperty property name
468 If IsMissing(pvItem) Then Call _TraceArguments()
469 If IsMissing(pvProperty) Then Call _TraceArguments()
470 If IsMissing(pvIndex) Then getProperty = PropertiesGet._getProperty(pvItem, pvProperty) Else getProperty = PropertiesGet._getProperty(pvItem, pvProperty, pvIndex)
472 End Function ' getProperty
474 REM -----------------------------------------------------------------------------------------------------------------------
475 Public Function getRecommendation(Optional pvObject As Variant) As Variant
476 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getRecommendation")
478 End Function ' getRecommendation
480 REM -----------------------------------------------------------------------------------------------------------------------
481 Public Function getRecordCount(Optional pvObject As Variant) As Variant
482 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getRecordCount")
484 End Function ' getRecordCount
486 REM -----------------------------------------------------------------------------------------------------------------------
487 Public Function getRecordset(Optional pvObject As Variant) As String
492 REM -----------------------------------------------------------------------------------------------------------------------
493 Public Function getRecordSource(Optional pvObject As Variant) As Variant
494 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getRecordSource")
496 End Function ' getRecordSource
498 REM -----------------------------------------------------------------------------------------------------------------------
499 Public Function getRequired(Optional pvObject As Variant) As Variant
502 End Function ' getRequired
504 REM -----------------------------------------------------------------------------------------------------------------------
505 Public Function getRowChangeAction(Optional pvObject As Variant) As Variant
506 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getRowChangeAction")
508 End Function ' getRowChangeAction
510 REM -----------------------------------------------------------------------------------------------------------------------
511 Public Function getRowSource(Optional pvObject As Variant) As Variant
514 End Function ' getRowSource
516 REM -----------------------------------------------------------------------------------------------------------------------
517 Public Function getRowSourceType(Optional pvObject As Variant) As Variant
518 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getRowSourceType")
520 End Function ' getRowSourceType
522 REM -----------------------------------------------------------------------------------------------------------------------
523 Public Function getSelected(Optional pvObject As Variant, ByVal Optional pvIndex As Variant) As Variant
525 If IsMissing(pvIndex) Then
527 Else
529 End If
530 End Function ' getSelected
532 REM -----------------------------------------------------------------------------------------------------------------------
533 Public Function getSize(Optional pvObject As Variant) As Variant
536 End Function ' getSize
538 REM -----------------------------------------------------------------------------------------------------------------------
539 Public Function getSource(Optional pvObject As Variant) As String
544 REM -----------------------------------------------------------------------------------------------------------------------
545 Public Function getSourceField(Optional pvObject As Variant) As Variant
546 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getSourceField")
548 End Function ' getSourceField
550 REM -----------------------------------------------------------------------------------------------------------------------
551 Public Function getSourceTable(Optional pvObject As Variant) As Variant
552 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getSourceTable")
554 End Function ' getSourceTable
556 REM -----------------------------------------------------------------------------------------------------------------------
557 Public Function getSpecialEffect(Optional pvObject As Variant) As Variant
558 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getSpecialEffect")
560 End Function ' getSpecialEffect
562 REM -----------------------------------------------------------------------------------------------------------------------
563 Public Function getSubType(Optional pvObject As Variant) As Variant
566 End Function ' getSubType
568 REM -----------------------------------------------------------------------------------------------------------------------
569 Public Function getSubComponentName(Optional pvObject As Variant) As Variant
570 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getSubComponentName")
572 End Function ' getSubComponentName
574 REM -----------------------------------------------------------------------------------------------------------------------
575 Public Function getSubComponentType(Optional pvObject As Variant) As Variant
576 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getSubComponentType")
578 End Function ' getSubComponentType
580 REM -----------------------------------------------------------------------------------------------------------------------
581 Public Function getTabIndex(Optional pvObject As Variant) As Variant
584 End Function ' getTabIndex
586 REM -----------------------------------------------------------------------------------------------------------------------
587 Public Function getTabStop(Optional pvObject As Variant) As Variant
590 End Function ' getTabStop
592 REM -----------------------------------------------------------------------------------------------------------------------
593 Public Function getTag(Optional pvObject As Variant) As Variant
596 End Function ' getTag
598 REM -----------------------------------------------------------------------------------------------------------------------
599 Public Function getText(Optional pvObject As Variant) As Variant
602 End Function ' getText
604 REM -----------------------------------------------------------------------------------------------------------------------
605 Public Function getTextAlign(Optional pvObject As Variant) As Variant
608 End Function ' getTextAlign
610 REM -----------------------------------------------------------------------------------------------------------------------
611 Public Function getTooltipText(Optional pvObject As Variant) As Variant
612 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getTooltipText")
614 End Function ' getTooltipText
616 REM -----------------------------------------------------------------------------------------------------------------------
617 Public Function getTripleState(Optional pvObject As Variant) As Variant
618 If IsMissing(pvObject) Or IsEmpty(pvObject) Then Call _TraceArguments("getTripleState")
620 End Function ' getTripleState
622 REM -----------------------------------------------------------------------------------------------------------------------
623 Public Function getTypeName(Optional pvObject As Variant) As Variant
626 End Function ' getTypeName
628 REM -----------------------------------------------------------------------------------------------------------------------
629 Public Function getVisible(Optional pvObject As Variant) As Variant
632 End Function ' getVisible
634 REM -----------------------------------------------------------------------------------------------------------------------
635 Public Function getWidth(Optional pvObject As Variant) As Long
638 End Function ' getWidth
640 REM -----------------------------------------------------------------------------------------------------------------------
641 Public Function getXPos(Optional pvObject As Variant) As Long
644 End Function ' getXPos
646 REM -----------------------------------------------------------------------------------------------------------------------
647 Public Function getYPos(Optional pvObject As Variant) As Long
650 End Function ' getYPos
652 REM -----------------------------------------------------------------------------------------------------------------------
653 REM --- PRIVATE FUNCTIONS ---
654 REM -----------------------------------------------------------------------------------------------------------------------
656 Public Function _getProperty(pvItem As Variant, ByVal psProperty As String, ByVal Optional pvIndex As Variant) As Variant
657 ' Return property value of the psProperty property name within object pvItem
659 If _ErrorHandler() Then On Local Error Goto Error_Function
661 _getProperty = Nothing
663 'pvItem must be an object and have the requested property
664 If Not Utils._CheckArgument(pvItem, 1, vbObject) Then Goto Exit_Function
665 If Not PropertiesGet._hasProperty(pvItem._Type, pvItem._PropertiesList(), psProperty) Then Goto Trace_Error
666 'Check Index argument
667 If Not IsMissing(pvIndex) Then
668 If Not Utils._CheckArgument(pvIndex, 3, Utils._AddNumeric()) Then Goto Exit_Function
669 End If
670 'Execute
671 Select Case UCase(psProperty)
673 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
674 _getProperty = pvItem.AbsolutePosition
676 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
677 _getProperty = pvItem.AllowAdditions
679 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
680 _getProperty = pvItem.AllowDeletions
682 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
683 _getProperty = pvItem.AllowEdits
685 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
686 _getProperty = pvItem.BackColor
688 If Not Utils._CheckArgument(pvItem, 1, OBJCOMMANDBARCONTROL) Then Goto Exit_Function
689 _getProperty = pvItem.BeginGroup
691 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
692 _getProperty = pvItem.BOF
694 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJRECORDSET)) Then Goto Exit_Function
695 _getProperty = pvItem.Bookmark
697 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
698 _getProperty = pvItem.Bookmarkable
700 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
701 _getProperty = pvItem.BorderColor
703 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
704 _getProperty = pvItem.BorderStyle
706 If Not Utils._CheckArgument(pvItem, 1, Array(OBJCOMMANDBAR, OBJCOMMANDBARCONTROL)) Then Goto Exit_Function
707 _getProperty = pvItem.BuiltIn
709 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
710 _getProperty = pvItem.ButtonLeft
712 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
713 _getProperty = pvItem.ButtonMiddle
715 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
716 _getProperty = pvItem.ButtonRight
718 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
719 _getProperty = pvItem.Cancel
721 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJDIALOG, OBJCONTROL, OBJCOMMANDBARCONTROL)) Then Goto Exit_Function
722 _getProperty = pvItem.Caption
724 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
725 _getProperty = pvItem.ClickCount
727 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
728 _getProperty = pvItem.ContextShortcut
730 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
731 _getProperty = pvItem.ControlSource
733 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
734 _getProperty = pvItem.ControlTipText
736 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
737 _getProperty = pvItem.ControlType
739 If Not Utils._CheckArgument(pvItem, 1, Array(OBJCOLLECTION,OBJOPTIONGROUP)) Then Goto Exit_Function
740 _getProperty = pvItem.Count
742 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
743 _getProperty = pvItem.CurrentRecord
745 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
746 _getProperty = pvItem.DataType
748 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
749 _getProperty = pvItem.DbType
751 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
752 _getProperty = pvItem.Default
754 If Not Utils._CheckArgument(pvItem, 1, Array(OBJCONTROL, OBJFIELD)) Then Goto Exit_Function
755 _getProperty = pvItem.DefaultValue
757 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
758 _getProperty = pvItem.Description
760 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
761 _getProperty = pvItem.EditMode
763 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
764 _getProperty = pvItem.Enabled
766 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
767 _getProperty = pvItem.EOF
769 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
770 _getProperty = pvItem.EventName
772 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
773 _getProperty = pvItem.EventType
775 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
776 _getProperty = pvItem.FieldSize
778 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM, OBJRECORDSET)) Then Goto Exit_Function
779 _getProperty = pvItem.Filter
781 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
782 _getProperty = pvItem.FilterOn
784 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
785 _getProperty = pvItem.FocusChangeTemporary
787 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
788 _getProperty = pvItem.FontBold
790 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
791 _getProperty = pvItem.FontItalic
793 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
794 _getProperty = pvItem.FontName
796 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
797 _getProperty = pvItem.FontSize
799 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
800 _getProperty = pvItem.FontUnderline
802 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
803 _getProperty = pvItem.FontWeight
805 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
806 _getProperty = pvItem.ForeColor
808 If Not Utils._CheckArgument(pvItem, 1, CTLSUBFORM) Then Goto Exit_Function
809 _getProperty = pvItem.Form
811 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
812 _getProperty = pvItem.Format
814 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJDIALOG)) Then Goto Exit_Function
815 _getProperty = pvItem.Height
817 If Not Utils._CheckArgument(pvItem, 1, OBJCOMMANDBARCONTROL) Then Goto Exit_Function
818 _getProperty = pvItem.Index
820 If Not Utils._CheckArgument(pvItem, 1, OBJFORM) Then Goto Exit_Function
821 _getProperty = pvItem.IsLoaded
823 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
824 If IsMissing(pvIndex) Then _getProperty = pvItem.ItemData Else _getProperty = pvItem.ItemData(pvIndex)
826 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
827 _getProperty = pvItem.KeyAlt
829 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
830 _getProperty = pvItem.KeyChar
832 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
833 _getProperty = pvItem.KeyCode
835 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
836 _getProperty = pvItem.KeyCtrl
838 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
839 _getProperty = pvItem.KeyFunction
841 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
842 _getProperty = pvItem.KeyShift
844 If Not Utils._CheckArgument(pvItem, 1, OBJSUBFORM) Then Goto Exit_Function
845 If IsMissing(pvIndex) Then _getProperty = pvItem.LinkChildFields Else _getProperty = pvItem.LinkChildFields(pvIndex)
847 If Not Utils._CheckArgument(pvItem, 1, OBJSUBFORM) Then Goto Exit_Function
848 If IsMissing(pvIndex) Then _getProperty = pvItem.LinkMasterFields Else _getProperty = pvItem.LinkMasterFields(pvIndex)
850 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
851 _getProperty = pvItem.ListCount
853 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
854 _getProperty = pvItem.ListIndex
856 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
857 If IsNull(pvItem.Locked) Then Goto Trace_Error
858 _ge ExitProperty = pvItem.Locked
860 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
861 _getProperty = pvItem.MultiSelect
863 If Not Utils._CheckArgument(pvItem, 1, _
864 Array(OBJFORM, OBJSUBFORM, OBJCONTROL, OBJOPTIONGROUP, OBJPROPERTY, OBJDIALOG, OBJTABLEDEF, OBJRECORDSET, OBJFIELD, OBJTEMPVAR, OBJCOMMANDBAR) _
865 ) Then Goto Exit_Function
866 _getProperty = pvItem.Name
868 If Not Utils._CheckArgument(pvItem, 1, Array(OBJDATABASE, OBJCOLLECTION, OBJFORM, OBJDIALOG, OBJSUBFORM, OBJCONTROL _
869 , OBJEVENT, OBJOPTIONGROUP, OBJPROPERTY, OBJRECORDSET, OBJTABLEDEF, OBJFIELD, OBJTEMPVAR _
870 , OBJCOMMANDBAR, OBJCOMMANDBARCONTROL) _
871 ) Then Goto Exit_Function
872 _getProperty = pvItem.ObjectType
874 If Not Utils._CheckArgument(pvItem, 1, OBJCOMMANDBARCONTROL) Then Goto Exit_Function
875 _getProperty = pvItem.OnAction
877 If Not Utils._CheckArgument(pvItem, 1, OBJFORM) Then Goto Exit_Function
878 _getProperty = pvItem.OpenArgs
880 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
881 _getProperty = pvItem.OptionValue
883 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
884 _getProperty = pvItem.OrderBy
886 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
887 _getProperty = pvItem.OrderByOn
889 If Not Utils._CheckArgument(pvItem, 1, Array(OBJDIALOG, OBJCONTROL)) Then Goto Exit_Function
890 _getProperty = pvItem.Page
892 If Not Utils._CheckArgument(pvItem, 1, Array(OBJSUBFORM, OBJCONTROL, OBJCOMMANDBARCONTROL)) Then Goto Exit_Function
893 _getProperty = pvItem.Parent
895 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
896 _getProperty = pvItem.Recommendation
898 If Not Utils._CheckArgument(pvItem, 1, OBJRECORDSET) Then Goto Exit_Function
899 _getProperty = pvItem.RecordCount
901 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
902 _getProperty = pvItem.Recordset
904 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJSUBFORM)) Then Goto Exit_Function
905 _getProperty = pvItem.RecordSource
907 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
908 _getProperty = pvItem.Required
910 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
911 _getProperty = pvItem.RowChangeAction
913 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
914 _getProperty = pvItem.RowSource
916 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
917 _getProperty = pvItem.RowSourceType
919 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
920 If IsMissing(pvIndex) Then _getProperty = pvItem.Selected Else _getProperty = pvItem.Selected(pvIndex)
922 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
923 _getProperty = pvItem.Size
925 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
926 _getProperty = pvItem.Source
928 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
929 _getProperty = pvItem.SourceTable
931 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
932 _getProperty = pvItem.SourceField
934 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
935 _getProperty = pvItem.SpecialEffect
937 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
938 _getProperty = pvItem.SubComponentName
940 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
941 _getProperty = pvItem.SubComponentType
943 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
944 _getProperty = pvItem.SubType
946 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
947 _getProperty = pvItem.TabIndex
949 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
950 _getProperty = pvItem.TabStop
952 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
953 _getProperty = pvItem.Tag
955 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
956 _getProperty = pvItem.Text
958 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
959 _getProperty = pvItem.TextAlign
961 If Not Utils._CheckArgument(pvItem, 1, OBJCOMMANDBARCONTROL) Then Goto Exit_Function
962 _getProperty = pvItem.TooltipText
964 If Not Utils._CheckArgument(pvItem, 1, OBJCONTROL) Then Goto Exit_Function
965 _getProperty = pvItem.TripleState
967 If Not Utils._CheckArgument(pvItem, 1, OBJFIELD) Then Goto Exit_Function
968 _getProperty = pvItem.TypeName
970 If Not Utils._CheckArgument(pvItem, 1, Array(OBJCONTROL, OBJOPTIONGROUP, OBJPROPERTY, OBJFIELD, OBJTEMPVAR)) Then Goto Exit_Function
971 _getProperty = pvItem.Value
973 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJDIALOG, OBJCONTROL, OBJCOMMANDBAR, OBJCOMMANDBARCONTROL)) Then Goto Exit_Function
974 _getProperty = pvItem.Visible
976 If Not Utils._CheckArgument(pvItem, 1, Array(OBJFORM, OBJDIALOG)) Then Goto Exit_Function
977 _getProperty = pvItem.Width
979 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
980 If IsNull(pvItem.XPos) Then Goto Trace_Error
981 _getProperty = pvItem.XPos
983 If Not Utils._CheckArgument(pvItem, 1, OBJEVENT) Then Goto Exit_Function
984 If IsNull(pvItem.YPos) Then Goto Trace_Error
985 _getProperty = pvItem.YPos
986 Case Else
987 Goto Trace_Error
988 End Select
990 Exit_Function:
992 Exit Function
993 Trace_Error:
995 _getProperty = Nothing
996 Goto Exit_Function
997 Trace_Error_Index:
999 _getProperty = Nothing
1000 Goto Exit_Function
1001 Error_Function:
1003 _getProperty = Nothing
1004 GoTo Exit_Function
1007 REM -----------------------------------------------------------------------------------------------------------------------
1008 Public Function _hasProperty(ByVal psObject As String, ByVal pvPropertiesList() As Variant, Optional ByVal pvProperty As Variant) As Boolean
1009 ' Return True if object has a valid property called pvProperty (case-insensitive comparison !)
1010 ' Generic hasProperty function called from all class modules
1012 Dim sObject As String
1013 sObject = Utils._PCase(psObject)
1015 If IsMissing(pvProperty) Then Call _TraceArguments()
1017 _hasProperty = False
1018 If Not Utils._CheckArgument(pvProperty, 1, vbString) Then Goto Exit_Function
1020 _hasProperty = Utils._InList(pvProperty, pvPropertiesList(), False, True)
1022 Exit_Function:
1024 Exit Function
1025 End Function ' _hasProperty
1027 REM ------------------------------------------------------------------------------------------------------------------------
1028 Public Function _ParentObject(psShortcut As String) As Object
1029 ' Return parent object from shortcut as a string
1031 Dim sParent As String, vParent() As Variant, iBound As Integer
1033 iBound = UBound(vParent) - 1
1039 Set _ParentObject = Nothing
1040 If Len(sParent) > Len(cstForm) Then
1041 If UCase(Right(sParent, Len(cstForm))) = cstForm Then
1042 Set _ParentObject = getValue(sParent)
1043 Else
1044 Set _ParentObject = getObject(sParent)
1045 End If
1046 End If
1050 REM -----------------------------------------------------------------------------------------------------------------------
1051 Public Function _Properties(ByVal psObject As String _
1052 , ByRef pvParent As Object _
1053 , ByVal pvPropertiesList() As Variant _
1054 , ByVal Optional pvIndex As Variant _
1055 ) As Variant
1056 ' Return
1057 ' a Collection object if pvIndex absent
1058 ' a Property object otherwise
1059 ' Generic function called from Properties methods stored in classes
1061 Dim vProperties As Variant, oCounter As Object, opProperty As Object
1062 Dim iArgNr As Integer, iLen As Integer
1066 vProperties = Null
1068 If IsMissing(pvIndex) Then ' Call without index argument prepares a Collection object
1069 Set oCounter = New Collect
1070 Set oCounter._This = oCounter
1071 oCounter._CollType = COLLPROPERTIES
1072 Set oCounter._Parent = pvParent
1073 oCounter._Count = UBound(pvPropertiesList) + 1
1074 Set vProperties = oCounter
1075 Else
1076 iLen = Len(psObject) + 1
1077 If Len(_A2B_.CalledSub) > iLen Then
1079 End If
1080 If Not Utils._CheckArgument(pvIndex, iArgNr, Utils._AddNumeric()) Then Goto Exit_Function
1083 Else
1084 Set opProperty = New Property
1085 Set opProperty._This = opProperty
1086 opProperty._Name = pvPropertiesList(pvIndex)
1087 opProperty._Value = Null
1088 Set vProperties = opProperty
1089 End If
1090 End If
1092 Exit_Function:
1093 Set _Properties = vProperties
1095 Exit Function
1096 End Function ' _Properties
1098 REM -----------------------------------------------------------------------------------------------------------------------
1099 Public Function _PropertiesList(pvObject As Variant) As Variant
1100 ' Return an array of strings containing the list of valid properties of pvObject
1102 Dim vProperties As Variant
1103 Dim vPropertiesList As Variant, bPropertiesList() As Boolean, sPropertiesList() As String
1104 Dim i As Integer, j As Integer, iCount As Integer
1106 Set vProperties = Nothing
1107 Select Case pvObject._Type
1108 Case OBJCOLLECTION, OBJPROPERTY, OBJFORM, OBJEVENT, OBJSUBFORM, OBJCONTROL, OBJOPTIONGROUP _
1109 , OBJDATABASE, OBJTABLEDEF, OBJQUERYDEF, OBJDIALOG, OBJFIELD, OBJRECORDSET, OBJTEMPVAR _
1110 , OBJCOMMANDBAR, OBJCOMMANDBARCONTROL
1111 vPropertiesList = pvObject._PropertiesList()
1112 Case Else
1113 End Select
1115 Exit_Function:
1116 Set _PropertiesList = vPropertiesList
1117 Exit Function
1120 </script:module>