LibreOffice 24.8 Help
A property, also called field or attribute, characterizes a given object or piece of information. Properties can be used to control access to data. It is common use to include instructions at setting or reading time of properties. Code can vary from simple assignment to complex context dependent routines. Using Get, Let or Set accessors enforces properties' consistency when necessary.
This statement requires Option Compatible to be placed before the executable program code in a module.
[Private | Public] Property Get name[char | As typename]
End Property
[Private | Public] Property [Let | Set] name[char] [([Optional [ByRef | ByVal]]value[char | As typename])] [As typename]
End Property
name: The property name.
argument: Value to be passed to the Property setter routine.
Property setters often use a single argument. Multiple arguments are equally accepted.
Option Compatible
Sub Main
ProductName = "Office"
Print ProductName ' displays "LibreOffice"
End Sub
Private _office As String
Property Get ProductName As String
ProductName = _office
End Property
Property Let ProductName(value As String)
_office = "Libre"& value
End Property
In the absence of Property Let or Property Set, Property Get helps define protected information, which can not be accidently altered by a foreign module:
Option Compatible
Public Property Get PathDelimiter As String ' Read-only variable
Static this As String
If this = "" Then : Select Case GetGuiType()
Case 1 : this = ";" ' Windows
Case 4 : this = ":" ' Linux or macOS
Case Else : Error 423 ' Property or method not defined: PathDelimiter
End Select : End If
PathDelimiter = this
End Property ' read-only PathDelimiter
Sub Main
PathDelimiter = "a sentence" ' does nothing
End Sub
Use Let or Set when handling UNO services or class objects:
Option Compatible
Sub Main
'Set anObject = CreateUnoService( "com.sun.star.frame.Desktop" )
anObject = CreateUnoService( "com.sun.star.frame.Desktop" )
Print anObject.SupportedServiceNames(0) ' displays "com.sun.star.frame.Frame"
End Sub
Property Get anObject As Object
Set anObject = _obj
End Property
Private _obj As Object
'Property Set anObject(value As Object)
'Set _obj = value.CurrentFrame
'End Property
Property Let anObject(value As Object)
Set _obj = value.CurrentFrame
End Property