System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Italic Property
Description
TRUE if the font attribute "Italic" is set for the language-dependent text in the object. BOOLEAN
write-read access.
Example:
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA540
Dim objLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "Hello"
Set objLangFonts = objButton.LDFonts
'
'To make fontsettings for french:
With objLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'
'To make fontsettings for english:
With objLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
Underlined Property (Page 2324)
Size Property (Page 2291)
Parent Property (Page 2241)
LanguageID Property (Page 2158)
FontFamily Property (Page 2127)
Bold Property (Page 2034)
Application Property (Page 2008)
LanguageFont Object (Page 1889)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2151
Item Property
Description
Returns an element from a listing. Depending on the specified object, you can use either the
index number or the name to return a particular element.
Example:
This example shows both kinds of indexing. In order for the example to work, create a group
object ("Group1") with two objects. The example outputs the height of the second object in a
group:
Sub GetHeight()
'VBA541
Dim objGroup As HMIGroup
'Next line uses the property "Item" to get a group by name
Set objGroup = ActiveDocument.HMIObjects.Item("Group1")
'Otherwise next line uses index to identify a groupobject
MsgBox "The height of object 2 is: " & objGroup.GroupedHMIObjects.Item(2).Height
End Sub
See also
VariableTriggers Object (Listing) (Page 1990)
VariableStateValues Object (Listing) (Page 1987)
AnalogResultInfos Object (Listing) (Page 1813)
ItemBorderBackColor Property
Description
Defines or returns the background color of the separation lines in the selection list for the
TextList object. LONG write-read access.
The background color is only visible with the property setting ItemBorderStyle > 0.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2152
System Manual, 11/2008,
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the background color for the separation lines will be set to "Red":
Sub TextListConfiguration()
'VBA542
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderBackColor = RGB(255, 0, 0)
End With
End Sub
See also
ItemBorderStyle Property (Page 2154)
TextList Object (Page 1964)
ItemBorderColor Property
Description
Defines or returns the color of the separation lines in the selection list for the TextList object.
LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the color for the separation lines will be set to "White":
Sub TextListConfiguration()
'VBA543
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderColor = RGB(255, 255, 255)
End With
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2153
End Sub
See also
TextList Object (Page 1964)
ItemBorderStyle Property
Description
Defines or returns the dividing line style in the selection list for the TextList object. Value range
from 0 to 4.
Line style Assigned Value
0
1
2
3
4
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the dividing line style will be set to "1":
Sub TextListConfiguration()
'VBA544
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderBackColor = RGB(255, 0, 0)
End With
End Sub
See also
TextList Object (Page 1964)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2154
System Manual, 11/2008,
ItemBorderWidth Property
Description
Defines or returns the weight in pixels of the dividing lines in the selection list for the TextList
object.
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the dividing line width will be set to "4":
'Sub E_628_TextListConfiguration()
Sub E_629_TextListConfiguration()
'VBA545
Dim objTextList As HMITextList
Set objTextList =
ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderWidth = 4
End With
End Sub
See also
TextList Object (Page 1964)
Key Property
Description
Returns the name that identifies the entry (menu point or icon) in the user-defined menu or
user-defined toolbar. Read only access.
Use the Key property to determine which entry was clicked. For this purpose you can use, say,
the events "MenuItemClicked" and "ToolBarItemClicked".
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"):
Sub CreateMenuItem()
'VBA546
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2155
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
'
'Add new menu "Delete objects" to menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Adds two menuitems to menu "Delete objects"
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
Rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete Circles")
End Sub
In connection with the "MenuItemClicked" event, you can connect the menu entries with
procedure calls, for instance. In this example the names of the menu entries will be output:
Sub Document_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
'VBA547
Dim strClicked As String
Dim objMenuItem As HMIMenuItem
Set objMenuItem = MenuItem
'
'"strClicked can get two values:
'(1) "DeleteAllRectangles" and
'(2) "DeleteAllCircles"
strClicked = objMenuItem.Key
'
'To analyse "strClicked" with "Select Case"
Select Case strClicked
Case "DeleteAllRectangles"
'
'Instead of "MsgBox" a procedurecall (e.g. "Call <Prozedurname>") can stay here
MsgBox "'Delete rectangle' was clicked"
Case "DeleteAllCircles"
MsgBox "'Delete Circles' was clicked"
End Select
End Sub
See also
ToolbarItem Object (Page 1970)
MenuItem Object (Page 1906)
InsertToolbarItem Method (Page 1769)
InsertMenuItem Method (Page 1765)
ToolbarItemClicked Event (Page 1701)
MenuItemClicked Event (Page 1695)
Creating Customized Menus and Toolbars (Page 1573)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2156
System Manual, 11/2008,
4.4.8.9 L
La
Label Property
Description
Returns the label of the user-defined menu or menu entry in the currently set language. Read
only access.
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries
("Delete Rectangles" and "Delete Circles"): In this example the labels will then be output:
Sub CreateMenuItem()
'VBA548
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim iIndex As Integer
iIndex = 1
'
'Add new menu "Delete objects" to menubar
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Adds two menuitems to menu "Delete objects"
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete circles")
MsgBox ActiveDocument.CustomMenus(1).Label
For iIndex = 1 To objMenu.MenuItems.Count
MsgBox objMenu.MenuItems(iIndex).Label
Next iIndex
End Sub
See also
CustomMenus Property (Page 2086)
MenuItems Object (Listing) (Page 1909)
MenuItem Object (Page 1906)
Menu Object (Page 1903)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2157
LanguageID Property
Description
Returns the language identifier of the project language as a decimal value. LONG read access
Example:
The "DataLanguages()" procedure outputs the project languages together with their language
identifiers:
Sub DataLanguages()
'VBA549
Dim colDataLang As HMIDataLanguages
Dim objDataLang As HMIDataLanguage
Dim nLangID As Long
Dim strLangName As String
Dim iAnswer As Integer
Set colDataLang = Application.AvailableDataLanguages
For Each objDataLang In colDataLang
nLangID = objDataLang.LanguageID
strLangName = objDataLang.LanguageName
iAnswer = MsgBox(nLangID & " " & strLangName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objDataLang
End Sub
See also
DataLanguages Object (Listing) (Page 1842)
DataLanguage Object (Page 1841)
LanguageName Property
Description
Returns the project language. STRING read access.
Example:
The "DataLanguages()" procedure outputs the project languages together with their language
identifiers:
Sub DataLanguages()
'VBA550
Dim colDataLang As HMIDataLanguages
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2158
System Manual, 11/2008,
Dim objDataLang As HMIDataLanguage
Dim nLangID As Long
Dim strLangName As String
Dim iAnswer As Integer
Set colDataLang = Application.AvailableDataLanguages
For Each objDataLang In colDataLang
nLangID = objDataLang.LanguageID
strLangName = objDataLang.LanguageName
iAnswer = MsgBox(nLangID & " " & strLangName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objDataLang
End Sub
See also
DataLanguages Object (Listing) (Page 1842)
DataLanguage Object (Page 1841)
LanguageSwitch Property
Description
Defines where the language-dependent assignment texts are stored or returns the value.
BOOLEAN write-read access.
TRUE, when the texts in the Text Library are managed. Translation to other language occurs
in the Text Library.
FALSE, when the texts are managed directly in the object. Translation to other language can
be carried out using Text Distributor.
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the texts will be managed in the Text Library:
Sub TextListConfiguration()
'VBA551
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.LanguageSwitch = True
End With
End Sub
See also
TextList Object (Page 1964)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2159
LastChange Property
Description
Returns the date on which the current picture was last changed. READ access.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in
the Graphics Designer. In this example the date of the last change to the current picture will
be output:
Sub ActiveDocumentConfiguration()
'VBA552
Dim varLastDocChange As Variant
varLastDocChange = Application.ActiveDocument.LastChange
MsgBox "Last changing: " & varLastDocChange
End Sub
See also
Document Object (Page 1847)
Layer Property
Description
Defines which layer of the picture an object is located in, or returns that information. There is
a total of 32 layers available, whereby Layer "0" is the bottom layer and Layer "31" the top
layer.
The configured objects are initially in the background of a layer.
Note
In VBA the numbering starts at "1". An entry of "objRectangle.Layer = 1" is therefore located
in the lowest layer.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2160
System Manual, 11/2008,