1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
|
VERSION 1.0 CLASS
BEGIN
MultiUse = -1 'True
END
Attribute VB_Name = "MigrationAnalyser"
Attribute VB_GlobalNameSpace = False
Attribute VB_Creatable = False
Attribute VB_PredeclaredId = False
Attribute VB_Exposed = False
'/*************************************************************************
' *
' DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
'
' Copyright 2000, 2010 Oracle and/or its affiliates.
'
' OpenOffice.org - a multi-platform office productivity suite
'
' This file is part of OpenOffice.org.
'
' OpenOffice.org is free software: you can redistribute it and/or modify
' it under the terms of the GNU Lesser General Public License version 3
' only, as published by the Free Software Foundation.
'
' OpenOffice.org is distributed in the hope that it will be useful,
' but WITHOUT ANY WARRANTY; without even the implied warranty of
' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
' GNU Lesser General Public License version 3 for more details
' (a copy is included in the LICENSE file that accompanied this code).
'
' You should have received a copy of the GNU Lesser General Public License
' version 3 along with OpenOffice.org. If not, see
' <http://www.openoffice.org/license.html>
' for a copy of the LGPLv3 License.
'
' ************************************************************************/
Option Explicit
'Class variables
Private Enum HFIssueType
hfInline
hfShape
hfFrame
End Enum
Private Enum HFIssueLocation
hfHeader
hffooter
End Enum
Private Type ShapeInfo
top As Single
Height As Single
End Type
Private Type FrameInfo
Height As Single
VerticalPosition As Single
End Type
Private mAnalysis As DocumentAnalysis
Private mOdd As Boolean
Private mbFormFieldErrorLogged As Boolean
Private mbRefFormFieldErrorLogged As Boolean
'***ADDING-ISSUE: Use Following Skeleton as Guideline for Adding Issue
' For complete list of all RID_STR_... for Issues (IssueType), SubIssues (SubType) and Attributes refer to:
' word_res.bas and common_res.bas
'
' For complete list of all CID_... for Issue Categories(IssueID) and
' CSTR_... for XML Issues (IssueTypeXML) and XML SubIssues (SubTypeXML) refer to:
' ApplicationSpecific.bas and CommonMigrationAnalyser.bas
'
' You should not have to add any new Issue Categories or matching IssueTypes, only new SubIssues
Sub Analyze_SKELETON()
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_SKELETON"
Dim myIssue As IssueInfo
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_VBA_MACROS 'Issue Category
.IssueType = RID_STR_COMMON_ISSUE_VBA_MACROS 'Issue String
.SubType = RID_STR_COMMON_SUBISSUE_PROPERTIES 'SubIssue String
.Location = .CLocationDocument 'Location string
.IssueTypeXML = CSTR_ISSUE_VBA_MACROS 'Non localised XML Issue String
.SubTypeXML = CSTR_SUBISSUE_PROPERTIES 'Non localised XML SubIssue String
.locationXML = .CXMLLocationDocument 'Non localised XML location
.SubLocation = 0 'if not set will default to RID_STR_NOT_AVAILABLE_SHORTHAND
.Line = 0 'if not set will default to RID_STR_NOT_AVAILABLE_SHORTHAND
.column = 0 'if not set will default to RID_STR_NOT_AVAILABLE_SHORTHAND
' Add as many Attribute Value pairs as needed
' Note: following must always be true - Attributes.Count = Values.Count
.Attributes.Add "AAA"
.Values.Add "foobar"
' Use AddIssueDetailsNote to add notes to the Issue Details if required
' Public Sub AddIssueDetailsNote(myIssue As IssueInfo, noteNum As Long, noteStr As String, _
' Optional preStr As String = RID_STR_COMMON_NOTE_PRE)
' Where preStr is prepended to the output, with "Note" as the default
AddIssueDetailsNote myIssue, 0, RID_STR_COMMON_NOTE_DOCUMENT_PROPERTIES_LOST
'Only put this in if you have a preparation function added for this issue in CommonPreparation
'or Preparation - NUll can be replaced with any variant if you want to pass info to the Prepare fnc
Call DoPreparation(mAnalysis, myIssue, "", Null, Null)
mAnalysis.IssuesCountArray(CID_VBA_MACROS) = _
mAnalysis.IssuesCountArray(CID_VBA_MACROS) + 1
End With
mAnalysis.Issues.Add myIssue
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub DoAnalyse(fileName As String, userFormTypesDict As Scripting.Dictionary, _
startDir As String, storeToDir As String, fso As FileSystemObject)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "DoAnalyse"
mAnalysis.name = fileName
Dim aDoc As Document
Dim bUnprotectError As Boolean
mAnalysis.TotalIssueTypes = CTOTAL_CATEGORIES
mbFormFieldErrorLogged = False
mbRefFormFieldErrorLogged = False
'Turn off any AutoExce macros before loading the Word doc
On Error Resume Next ' Ignore errors on setting
WordBasic.DisableAutoMacros 1
On Error GoTo HandleErrors
Dim myPassword As String
myPassword = GetDefaultPassword
'Always skip password protected documents
'If IsSkipPasswordDocs() Then
Dim aPass As String
If myPassword <> "" Then
aPass = myPassword
Else
aPass = "xoxoxoxoxo"
End If
On Error Resume Next
Set aDoc = Documents.Open(fileName, False, False, False, _
aPass, aPass, False, aPass, aPass, wdOpenFormatAuto, _
msoEncodingAutoDetect, False)
If Err.Number = 5408 Then
' if password protected, try open readonly next
Set aDoc = Documents.Open(fileName, False, True, False, _
aPass, aPass, False, aPass, aPass, wdOpenFormatAuto, _
msoEncodingAutoDetect, False)
End If
If Err.Number = 5408 Then
HandleProtectedDocInvalidPassword mAnalysis, _
"User entered Invalid Document Password, further analysis not possible", fso
Analyze_Password_Protection True, False
GoTo FinalExit
ElseIf (Err.Number <> 0) Then
GoTo HandleErrors
End If
On Error GoTo HandleErrors
If aDoc Is Nothing Then GoTo FinalExit
'Do Analysis
Analyze_Password_Protection aDoc.HasPassword, aDoc.WriteReserved
Analyze_Document_Protection aDoc
If aDoc.ProtectionType <> wdNoProtection Then
If myPassword <> "" Then
aDoc.Unprotect (myPassword)
Else
aDoc.Unprotect
End If
End If
'Set Doc Properties
SetDocProperties mAnalysis, aDoc, fso
ContinueFromUnprotectError:
Analyze_Tables_TablesInTables aDoc
Analyze_Tables_Borders aDoc
Analyze_TOA aDoc
If Not bUnprotectError Then
Analyze_FieldAndFormFieldIssues aDoc
End If
Analyze_OLEEmbedded aDoc
Analyze_MailMerge_DataSource aDoc
Analyze_Macros mAnalysis, userFormTypesDict, aDoc
'Analyze_Numbering aDoc, mAnalysis
'Analyze_NumberingTabs aDoc, mAnalysis
' Doc Preparation only
' Save document with any prepared issues under <storeToDir>\prepared\<source doc name>
If mAnalysis.PreparableIssuesCount > 0 And CheckDoPrepare Then
Dim preparedFullPath As String
preparedFullPath = GetPreparedFullPath(mAnalysis.name, startDir, storeToDir, fso)
If preparedFullPath <> "" Then
If fso.FileExists(preparedFullPath) Then
fso.DeleteFile preparedFullPath, True
End If
If fso.FolderExists(fso.GetParentFolderName(preparedFullPath)) Then
aDoc.SaveAs preparedFullPath
End If
End If
End If
'DebugMacroInfo
FinalExit:
If Not aDoc Is Nothing Then 'If Not IsEmpty(aDoc) Then
aDoc.Close (False)
End If
Set aDoc = Nothing
Exit Sub
HandleErrors:
' MsgBox currentFunctionName & " : " & fileName & ": " & Err.Number & " " & Err.Description & " " & Err.Source
' Handle Password error on Doc Open, Modify and Cancel
If Err.Number = 5408 Or Err.Number = 4198 Then
WriteDebug currentFunctionName & " : " & fileName & ": " & _
"User entered Invalid Document Password - " & Err.Number & " " & Err.Description & " " & Err.Source
HandleProtectedDocInvalidPassword mAnalysis, _
"User entered Invalid Document Password, further analysis not possible", fso
Resume FinalExit
ElseIf Err.Number = 5485 Then
' Handle Password error on Unprotect Doc
WriteDebug currentFunctionName & " : " & fileName & ": " & _
"User entered Invalid Document Part Password, Analysis of doc will continue but will skip analysis of:" & _
"Forms, Comments, Headers & Footers and Table cell spanning issues - " & Err.Number & " " & Err.Description & " " & Err.Source
HandleProtectedDocInvalidPassword mAnalysis, _
"User entered Invalid Document Part Password, Analysis of doc will continue but will skip analysis of:" & vbLf & _
"Forms, Comments, Headers & Footers and Table cell spanning issues", fso
bUnprotectError = True
'wdAllowOnlyComments, wdAllowOnlyFormFields, wdAllowOnlyRevisions
Resume ContinueFromUnprotectError
End If
mAnalysis.Application = RID_STR_COMMON_CANNOT_OPEN
WriteDebug currentFunctionName & " : " & fileName & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub DebugMacroInfo()
MsgBox "TotalNumLines: " & mAnalysis.MacroTotalNumLines & vbLf & _
"NumUserForms: " & mAnalysis.MacroNumUserForms & vbLf & _
"NumUserFormControls: " & mAnalysis.MacroNumUserFormControls & vbLf & _
"NumUserFormControlTypes: " & mAnalysis.MacroNumUserFormControlTypes & vbLf & _
"NumExternalRefs: " & mAnalysis.MacroNumExternalRefs & vbLf & _
"MacroNumFieldsUsingMacros: " & mAnalysis.MacroNumFieldsUsingMacros & vbLf & _
"NumOLEControls: " & mAnalysis.MacroNumOLEControls & vbLf & _
"MacroOverallClass: " & getDocOverallMacroClassAsString(mAnalysis.MacroOverallClass)
End Sub
Sub SetDocProperties(docAnalysis As DocumentAnalysis, doc As Document, fso As FileSystemObject)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "SetProperties"
Dim f As File
Set f = fso.GetFile(docAnalysis.name)
docAnalysis.PageCount = doc.ComputeStatistics(wdStatisticPages)
docAnalysis.Accessed = f.DateLastAccessed
On Error Resume Next 'Some apps may not support all props
docAnalysis.Application = getAppSpecificApplicationName & " " & Application.Version
'docAnalysis.Application = doc.BuiltinDocumentProperties(wdPropertyAppName)
'If InStr(docAnalysis.Application, "Microsoft") = 1 Then
' docAnalysis.Application = Mid(docAnalysis.Application, Len("Microsoft") + 2)
'End If
'If InStr(Len(docAnalysis.Application) - 2, docAnalysis.Application, ".") = 0 Then
' docAnalysis.Application = docAnalysis.Application & " " & Application.Version
'End If
docAnalysis.Created = _
doc.BuiltInDocumentProperties(wdPropertyTimeCreated)
docAnalysis.Modified = _
doc.BuiltInDocumentProperties(wdPropertyTimeLastSaved)
docAnalysis.Printed = _
doc.BuiltInDocumentProperties(wdPropertyTimeLastPrinted)
docAnalysis.SavedBy = _
doc.BuiltInDocumentProperties(wdPropertyLastAuthor)
docAnalysis.Revision = _
val(doc.BuiltInDocumentProperties(wdPropertyRevision))
docAnalysis.Template = _
fso.GetFileName(doc.BuiltInDocumentProperties(wdPropertyTemplate))
FinalExit:
Set f = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
'Limitation: Detect first level table in tables, does not detect further nesting
'Can do so if required
Sub Analyze_Tables_TablesInTables(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_Tables_TablesInTables"
Dim myTopTable As Table
Dim myInnerTable As Table
Dim myIssue As IssueInfo
For Each myTopTable In currDoc.Tables
For Each myInnerTable In myTopTable.Tables
Dim logString As String
Dim myRng As Range
Dim startpage As Long
Dim startRow As Long
Dim StartColumn As Long
Dim details As String
Set myIssue = New IssueInfo
Set myRng = myInnerTable.Range
myRng.start = myRng.End
startpage = myRng.Information(wdActiveEndPageNumber)
startRow = myRng.Information(wdStartOfRangeRowNumber)
StartColumn = myRng.Information(wdStartOfRangeColumnNumber)
With myIssue
.IssueID = CID_TABLES
.IssueType = RID_STR_WORD_ISSUE_TABLES
.SubType = RID_STR_WORD_SUBISSUE_NESTED_TABLES
.Location = .CLocationPage
.SubLocation = startpage
.IssueTypeXML = CSTR_ISSUE_TABLES
.SubTypeXML = CSTR_SUBISSUE_NESTED_TABLES
.locationXML = .CXMLLocationPage
.Attributes.Add RID_STR_WORD_ATTRIBUTE_OUTER_TABLE
.Values.Add myTopTable.Rows.count & "x" & myTopTable.Columns.count
.Attributes.Add RID_STR_WORD_ATTRIBUTE_INNER_TABLE
.Values.Add myInnerTable.Rows.count & "x" & myInnerTable.Columns.count
.Attributes.Add RID_STR_WORD_ATTRIBUTE_START_ROW
.Values.Add startRow
.Attributes.Add RID_STR_WORD_ATTRIBUTE_START_COL
.Values.Add StartColumn
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_NESTED_TABLE_WILL_BE_LOST
mAnalysis.IssuesCountArray(CID_TABLES) = _
mAnalysis.IssuesCountArray(CID_TABLES) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
Set myRng = Nothing
Next
Next
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
End Sub
Sub Analyze_Document_Protection(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_Document_Protection"
If currDoc.ProtectionType = wdNoProtection Then
Exit Sub
End If
Dim myIssue As IssueInfo
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_CONTENT_AND_DOCUMENT_PROPERTIES
.IssueType = RID_STR_COMMON_ISSUE_CONTENT_AND_DOCUMENT_PROPERTIES
.SubType = RID_STR_COMMON_SUBISSUE_DOCUMENT_PARTS_PROTECTION
.Location = .CLocationDocument
.IssueTypeXML = CSTR_ISSUE_CONTENT_DOCUMENT_PROPERTIES
.SubTypeXML = CSTR_SUBISSUE_DOCUMENT_PARTS_PROTECTION
.locationXML = .CXMLLocationDocument
.Attributes.Add RID_STR_WORD_ATTRIBUTE_PROTECTION
Select Case currDoc.ProtectionType
Case wdAllowOnlyComments
.Values.Add RID_STR_WORD_ATTRIBUTE_ALLOW_ONLY_COMMENTS
Case wdAllowOnlyFormFields
.Values.Add RID_STR_WORD_ATTRIBUTE_ALLOW_ONLY_FORM_FIELDS
Case wdAllowOnlyRevisions
.Values.Add RID_STR_WORD_ATTRIBUTE_ALLOW_ONLY_REVISIONS
Case Else
.Values.Add RID_STR_COMMON_ATTRIBUTE_UNKNOWN
End Select
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) = _
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) + 1
End With
mAnalysis.Issues.Add myIssue
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub Analyze_Password_Protection(bHasPassword As Boolean, bWriteReserved As Boolean)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_Password_Protection"
Dim myIssue As IssueInfo
If bHasPassword Or bWriteReserved Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_CONTENT_AND_DOCUMENT_PROPERTIES
.IssueType = RID_STR_COMMON_ISSUE_CONTENT_AND_DOCUMENT_PROPERTIES
.SubType = RID_STR_COMMON_SUBISSUE_PASSWORDS_PROTECTION
.Location = .CLocationDocument
.IssueTypeXML = CSTR_ISSUE_CONTENT_DOCUMENT_PROPERTIES
.SubTypeXML = CSTR_SUBISSUE_PASSWORDS_PROTECTION
.locationXML = .CXMLLocationDocument
If bHasPassword Then
.Attributes.Add RID_STR_WORD_ATTRIBUTE_PASSWORD_TO_OPEN
.Values.Add RID_STR_WORD_ATTRIBUTE_SET
End If
If bWriteReserved Then
.Attributes.Add RID_STR_WORD_ATTRIBUTE_PASSWORD_TO_MODIFY
.Values.Add RID_STR_WORD_ATTRIBUTE_SET
End If
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) = _
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) + 1
End With
mAnalysis.Issues.Add myIssue
End If
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub Analyze_OLEEmbedded(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_OLEEmbedded"
' Handle Inline Shapes
Dim aILShape As InlineShape
For Each aILShape In currDoc.InlineShapes
Analyze_OLEEmbeddedSingleInlineShape aILShape
Next aILShape
' Handle Shapes
Dim aShape As Shape
For Each aShape In currDoc.Shapes
Analyze_OLEEmbeddedSingleShape mAnalysis, aShape, _
Selection.Information(wdActiveEndPageNumber)
Analyze_Lines mAnalysis, aShape, _
Selection.Information(wdActiveEndPageNumber)
Analyze_Transparency mAnalysis, aShape, _
Selection.Information(wdActiveEndPageNumber)
Analyze_Gradients mAnalysis, aShape, _
Selection.Information(wdActiveEndPageNumber)
Next aShape
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
End Sub
'WdInlineShapeType constants:
'wdInlineShapeEmbeddedOLEObject, wdInlineShapeHorizontalLine, wdInlineShapeLinkedOLEObject,
'wdInlineShapeLinkedPicture, wdInlineShapeLinkedPictureHorizontalLine, wdInlineShapeOLEControlObject,
'wdInlineShapeOWSAnchor, wdInlineShapePicture, wdInlineShapePictureBullet,
'wdInlineShapePictureHorizontalLine, wdInlineShapeScriptAnchor
Sub Analyze_OLEEmbeddedSingleInlineShape(aILShape As InlineShape)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_OLEEmbeddedSingleInlineShape"
Dim myIssue As IssueInfo
Dim bOleObject As Boolean
Dim TypeAsString As String
Dim XMLTypeAsString As String
Dim objName As String
bOleObject = (aILShape.Type = wdInlineShapeEmbeddedOLEObject) Or _
(aILShape.Type = wdInlineShapeLinkedOLEObject) Or _
(aILShape.Type = wdInlineShapeOLEControlObject)
If Not bOleObject Then Exit Sub
aILShape.Select
Select Case aILShape.Type
Case wdInlineShapeOLEControlObject
TypeAsString = RID_STR_COMMON_OLE_CONTROL
XMLTypeAsString = CSTR_SUBISSUE_OLE_CONTROL
Case wdInlineShapeEmbeddedOLEObject
TypeAsString = RID_STR_COMMON_OLE_EMBEDDED
XMLTypeAsString = CSTR_SUBISSUE_OLE_EMBEDDED
Case wdInlineShapeLinkedOLEObject
TypeAsString = RID_STR_COMMON_OLE_LINKED
XMLTypeAsString = CSTR_SUBISSUE_OLE_LINKED
Case Else
TypeAsString = RID_STR_COMMON_OLE_UNKNOWN
XMLTypeAsString = CSTR_SUBISSUE_OLE_UNKNOWN
End Select
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_PORTABILITY
.IssueType = RID_STR_COMMON_ISSUE_PORTABILITY
.SubType = TypeAsString
.Location = .CLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.IssueTypeXML = CSTR_ISSUE_PORTABILITY
.SubTypeXML = XMLTypeAsString
.locationXML = .CXMLLocationPage
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
DoEvents
If aILShape.Type = wdInlineShapeEmbeddedOLEObject Or _
aILShape.Type = wdInlineShapeOLEControlObject Then
'If Object is invalid can get automation server hanging
Dim tmpStr As String
On Error Resume Next
tmpStr = aILShape.OLEFormat.Object
If Err.Number = 0 Then
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_OBJECT_TYPE
.Values.Add aILShape.OLEFormat.ProgID
Else
Err.Clear
tmpStr = aILShape.OLEFormat.ClassType
If Err.Number = 0 Then
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_OBJECT_TYPE
.Values.Add aILShape.OLEFormat.ClassType
Else
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_OBJECT_TYPE
.Values.Add RID_STR_COMMON_NA
End If
End If
If aILShape.Type = wdInlineShapeOLEControlObject Then
mAnalysis.MacroNumOLEControls = 1 + mAnalysis.MacroNumOLEControls
End If
objName = aILShape.OLEFormat.Object.name
If Err.Number = 0 Then
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_OBJECT_NAME
.Values.Add objName
End If
On Error GoTo HandleErrors
End If
If aILShape.Type = wdInlineShapeLinkedOLEObject Then
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_SOURCE
.Values.Add aILShape.LinkFormat.SourceFullName
End If
mAnalysis.IssuesCountArray(CID_PORTABILITY) = _
mAnalysis.IssuesCountArray(CID_PORTABILITY) + 1
End With
mAnalysis.Issues.Add myIssue
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebugLevelTwo currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
'Appears to be picked up by other OLE analysis code - the Shapes are actually field codes
'So I get double reporting if I use this as well.
Sub Analyze_OLEFields(myField As Field)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_OLEFields"
Dim myIssue As IssueInfo
Dim bOleObject As Boolean
Dim TypeAsString As String
Dim XMLTypeAsString As String
bOleObject = (myField.Type = wdFieldOCX)
If Not bOleObject Then Exit Sub
myField.Select
Select Case myField.Type
Case wdFieldLink
TypeAsString = RID_STR_COMMON_OLE_FIELD_LINK
XMLTypeAsString = CSTR_SUBISSUE_OLE_FIELD_LINK
Case Else
TypeAsString = RID_STR_COMMON_OLE_UNKNOWN
XMLTypeAsString = CSTR_SUBISSUE_OLE_UNKNOWN
End Select
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_PORTABILITY
.IssueType = RID_STR_COMMON_ISSUE_PORTABILITY
.SubType = TypeAsString
.Location = .CLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.IssueTypeXML = CSTR_ISSUE_PORTABILITY
.SubTypeXML = XMLTypeAsString
.locationXML = .CXMLLocationPage
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_OBJECT_TYPE
.Values.Add myField.OLEFormat.ClassType
If myField.Type = wdFieldLink Then
.Attributes.Add RID_STR_WORD_ATTRIBUTE_LINK
.Values.Add myField.LinkFormat.SourceFullName
End If
mAnalysis.IssuesCountArray(CID_PORTABILITY) = _
mAnalysis.IssuesCountArray(CID_PORTABILITY) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
Exit Sub
HandleErrors:
Set myIssue = Nothing
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
End Sub
Sub Analyze_MailMergeField(myField As Field)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_MailMergeField"
Dim myIssue As IssueInfo
Dim TypeAsString As String
Dim bProblemMailMergeField As Boolean
bProblemMailMergeField = _
(myField.Type = wdFieldFillIn) Or _
(myField.Type = wdFieldAsk) Or _
(myField.Type = wdFieldMergeRec) Or _
(myField.Type = wdFieldMergeField) Or _
(myField.Type = wdFieldNext) Or _
(myField.Type = wdFieldRevisionNum) Or _
(myField.Type = wdFieldSequence) Or _
(myField.Type = wdFieldAutoNum) Or _
(myField.Type = wdFieldAutoNumOutline) Or _
(myField.Type = wdFieldAutoNumLegal)
If bProblemMailMergeField Then
'Some of the following are numbering fields and need to be broken out into a seperate function. See migration guide.
Select Case myField.Type
Case wdFieldFillIn
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_FILL_IN
Case wdFieldAsk
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_ASK
Case wdFieldMergeRec
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_MERGE_RECORDS
Case wdFieldMergeField
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_MERGE_FIELDS
Case wdFieldNext
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_NEXT
Case wdFieldRevisionNum
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_REVISION_NUMBER
Case wdFieldSequence
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_SEQUENCE
Case wdFieldAutoNum
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_AUTO_NUMBER
Case wdFieldAutoNumOutline
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_AUTO_NUMBER_OUTLINE
Case wdFieldAutoNumLegal
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_AUTO_NUMBER_LEGAL
Case Else
TypeAsString = RID_STR_WORD_ENUMERATION_MAILMERGE_FIELD_NAME_NOT_KNOWN
End Select
Set myIssue = New IssueInfo
myField.Select
With myIssue
.IssueID = CID_FIELDS
.IssueType = RID_STR_WORD_ISSUE_FIELDS
.SubType = RID_STR_WORD_SUBISSUE_MAILMERGE_FIELD
.Location = .CLocationPage
.IssueTypeXML = CSTR_ISSUE_FIELDS
.SubTypeXML = CSTR_SUBISSUE_MAILMERGE_FIELD
.locationXML = .CXMLLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_NAME
.Values.Add TypeAsString
If myField.Code.Text <> "" Then
.Attributes.Add RID_STR_WORD_ATTRIBUTE_TEXT
.Values.Add myField.Code.Text
End If
mAnalysis.IssuesCountArray(CID_FIELDS) = _
mAnalysis.IssuesCountArray(CID_FIELDS) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
End Sub
'Get field DS Info
Sub Analyze_MailMerge_DataSource(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_MailMerge_DataSource"
' There may be no mail merge in the document
If (currDoc.MailMerge.DataSource.Type = wdNoMergeInfo) Then
Exit Sub
End If
'Dim issue As SimpleAnalysisInfo
If (currDoc.MailMerge.DataSource.Type <> wdNoMergeInfo) Then
Dim myIssue As IssueInfo
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_CONTENT_AND_DOCUMENT_PROPERTIES
.IssueType = RID_STR_COMMON_ISSUE_CONTENT_AND_DOCUMENT_PROPERTIES
.SubType = RID_STR_WORD_SUBISSUE_MAILMERGE_DATASOURCE
.Location = .CLocationDocument
.IssueTypeXML = CSTR_ISSUE_CONTENT_DOCUMENT_PROPERTIES
.SubTypeXML = CSTR_SUBISSUE_MAILMERGE_DATASOURCE
.locationXML = .CXMLLocationDocument
.Attributes.Add RID_STR_COMMON_ATTRIBUTE_NAME
.Values.Add currDoc.MailMerge.DataSource.name
.Attributes.Add RID_STR_WORD_ATTRIBUTE_DATASOURCE
.Values.Add currDoc.MailMerge.DataSource.Type
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) = _
mAnalysis.IssuesCountArray(CID_CONTENT_AND_DOCUMENT_PROPERTIES) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
End Sub
Function getFormFieldTypeAsString(fieldType As WdFieldType)
Dim Str As String
Select Case fieldType
Case wdFieldFormCheckBox
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_CHECK_BOX
Case wdFieldFormDropDown
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DROP_DOWN
Case wdFieldFormTextInput
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_TEXT
Case Else
Str = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
getFormFieldTypeAsString = Str
End Function
Function getTextFormFieldTypeAsString(fieldType As WdTextFormFieldType)
Dim Str As String
Select Case fieldType
Case wdCalculationText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_CALCULATION
Case wdCurrentDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_CURRENT_DATE
Case wdCurrentTimeText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_CURRENT_TIME
Case wdDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DATE
Case wdNumberText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_NUMBER
Case wdRegularText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_REGULAR
Case Else
Str = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
getTextFormFieldTypeAsString = Str
End Function
Function getTextFormFieldDefaultAsString(fieldType As WdTextFormFieldType)
Dim Str As String
Select Case fieldType
Case wdCalculationText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_EXPRESSION
Case wdCurrentDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_DATE
Case wdCurrentTimeText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_TIME
Case wdDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_DATE
Case wdNumberText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_NUMBER
Case wdRegularText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_DEFAULT_TEXT
Case Else
Str = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
getTextFormFieldDefaultAsString = Str
End Function
Function getTextFormFieldFormatAsString(fieldType As WdTextFormFieldType)
Dim Str As String
Select Case fieldType
Case wdCalculationText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_NUMBER
Case wdCurrentDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_DATE
Case wdCurrentTimeText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_TIME
Case wdDateText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_DATE
Case wdNumberText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_NUMBER
Case wdRegularText
Str = RID_STR_WORD_ENUMERATION_FORM_FIELD_FORMAT_TEXT
Case Else
Str = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
getTextFormFieldFormatAsString = Str
End Function
Sub Analyze_FieldAndFormFieldIssues(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_FormFields"
Dim myIssue As IssueInfo
'Analysze all Fields in doc
Dim myField As Field
For Each myField In currDoc.Fields
'Analyze Mail Merge Fields
Analyze_MailMergeField myField
'Analyze TOA Fields
Analyze_TOAField myField
Next myField
'Analyze FormField doc issues
If currDoc.FormFields.count = 0 Then GoTo FinalExit
If (currDoc.FormFields.Shaded) Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_FIELDS
.IssueType = RID_STR_WORD_ISSUE_FIELDS
.SubType = RID_STR_WORD_SUBISSUE_APPEARANCE
.Location = .CLocationDocument
.IssueTypeXML = CSTR_ISSUE_FIELDS
.SubTypeXML = CSTR_SUBISSUE_APPEARANCE
.locationXML = .CXMLLocationDocument
.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_GREYED
.Values.Add RID_STR_WORD_TRUE
mAnalysis.IssuesCountArray(CID_FIELDS) = _
mAnalysis.IssuesCountArray(CID_FIELDS) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
'Analyse all FormFields in doc
Dim myFormField As FormField
For Each myFormField In currDoc.FormFields
Analyze_FormFieldIssue myFormField
Next myFormField
FinalExit:
Set myIssue = Nothing
Set myFormField = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub Analyze_FormFieldIssue(myFormField As FormField)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_FormFieldIssue"
Dim myIssue As IssueInfo
Dim bCheckBoxIssues As Boolean
Dim bFormFieldIssues As Boolean
bCheckBoxIssues = False
If (myFormField.Type = wdFieldFormCheckBox) Then
If myFormField.CheckBox.AutoSize Then
bCheckBoxIssues = True
End If
End If
bFormFieldIssues = bCheckBoxIssues
If Not bFormFieldIssues Then GoTo FinalExit
myFormField.Select
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_FIELDS
.IssueType = RID_STR_WORD_ISSUE_FIELDS
.SubType = RID_STR_WORD_SUBISSUE_FORM_FIELD
.Location = .CLocationPage
.IssueTypeXML = CSTR_ISSUE_FIELDS
.SubTypeXML = CSTR_SUBISSUE_FORM_FIELD
.locationXML = .CXMLLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
myIssue.Attributes.Add RID_STR_COMMON_ATTRIBUTE_TYPE
myIssue.Values.Add getFormFieldTypeAsString(myFormField.Type)
End With
'Checkbox Issues
If (myFormField.Type = wdFieldFormCheckBox) Then
'AutoSize CheckBoxes
If myFormField.CheckBox.AutoSize Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_AUTOSIZE
myIssue.Values.Add RID_STR_WORD_TRUE
End If
End If
'TextInput Issues
If myFormField.Type = wdFieldFormTextInput Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_TEXT_FORM_FIELD_TYPE
myIssue.Values.Add getTextFormFieldTypeAsString(myFormField.TextInput.Type)
Dim bLostType As Boolean
bLostType = False
If (myFormField.TextInput.Type = wdCalculationText) Or _
(myFormField.TextInput.Type = wdCurrentDateText) Or _
(myFormField.TextInput.Type = wdCurrentTimeText) Then
AddIssueDetailsNote myIssue, 0, getTextFormFieldTypeAsString(myFormField.TextInput.Type) & _
" " & RID_STR_WORD_NOTE_FORM_FIELD_TYPE_LOST
bLostType = True
End If
If (myFormField.TextInput.Format <> "") Then
myIssue.Attributes.Add getTextFormFieldFormatAsString(myFormField.TextInput.Type)
myIssue.Values.Add myFormField.TextInput.Format
End If
'Default text
If (myFormField.TextInput.Default <> "") Then
myIssue.Attributes.Add getTextFormFieldDefaultAsString(myFormField.TextInput.Type)
myIssue.Values.Add myFormField.TextInput.Default
End If
'Maximum text
If (myFormField.TextInput.Width <> 0) Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_MAX_LENGTH
myIssue.Values.Add myFormField.TextInput.Width
End If
'Fill-in disabled
If (myFormField.Enabled = False) And (Not bLostType) Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_FILLIN_ENABLED
myIssue.Values.Add RID_STR_WORD_FALSE
End If
End If
'Help Key(F1)
If (myFormField.OwnHelp And myFormField.HelpText <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_HELP_KEY_F1_OWN_TEXT
myIssue.Values.Add myFormField.HelpText
ElseIf ((Not myFormField.OwnHelp) And myFormField.HelpText <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_HELP_KEY_F1_AUTO_TEXT
myIssue.Values.Add myFormField.HelpText
End If
'StatusHelp
If (myFormField.OwnStatus And myFormField.StatusText <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_STATUS_BAR_HELP_OWN_TEXT
myIssue.Values.Add myFormField.StatusText
ElseIf ((Not myFormField.OwnStatus) And myFormField.StatusText <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_STATUS_BAR_HELP_AUTO_TEXT
myIssue.Values.Add myFormField.StatusText
End If
'Macros
If (myFormField.EntryMacro <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_ENTRY_MACRO
myIssue.Values.Add myFormField.EntryMacro
End If
If (myFormField.ExitMacro <> "") Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_EXIT_MACRO
myIssue.Values.Add myFormField.ExitMacro
End If
If (myFormField.EntryMacro <> "") Or (myFormField.ExitMacro <> "") Then
mAnalysis.MacroNumFieldsUsingMacros = 1 + mAnalysis.MacroNumFieldsUsingMacros
End If
'LockedField
If (myFormField.Enabled = False) And (myFormField.Type <> wdFieldFormTextInput) Then
myIssue.Attributes.Add RID_STR_WORD_ATTRIBUTE_FORM_FIELD_LOCKED
myIssue.Values.Add RID_STR_WORD_TRUE
End If
mAnalysis.IssuesCountArray(CID_FIELDS) = _
mAnalysis.IssuesCountArray(CID_FIELDS) + 1
mAnalysis.Issues.Add myIssue
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
'Log first occurence for this doc
If Not mbFormFieldErrorLogged Then
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
mbFormFieldErrorLogged = True
End If
Resume FinalExit
End Sub
Sub Analyze_TOA(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_TOA"
Dim toa As TableOfAuthorities
Dim myIssue As IssueInfo
Dim myRng As Range
For Each toa In currDoc.TablesOfAuthorities
Set myRng = toa.Range
myRng.start = myRng.End
Set myIssue = New IssueInfo
myRng.Select
Dim TabLeaderAsString As String
Select Case toa.TabLeader
Case wdTabLeaderDashes
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_DASHES
Case wdTabLeaderDots
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_DOTS
Case wdTabLeaderHeavy
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_HEAVY
Case wdTabLeaderLines
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_LINES
Case wdTabLeaderMiddleDot
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_MIDDLEDOT
Case wdTabLeaderSpaces
TabLeaderAsString = RID_STR_WORD_ENUMERATION_INDEX_LEADER_SPACES
Case Else
TabLeaderAsString = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
Dim FormatAsString As String
Select Case currDoc.TablesOfAuthorities.Format
Case wdTOAClassic
FormatAsString = RID_STR_WORD_ENUMERATION_INDEX_TABLES_CLASSIC
Case wdTOADistinctive
FormatAsString = RID_STR_WORD_ENUMERATION_INDEX_TABLES_DISTINCTIVE
Case wdTOAFormal
FormatAsString = RID_STR_WORD_ENUMERATION_INDEX_TABLES_FORMAL
Case wdTOASimple
FormatAsString = RID_STR_WORD_ENUMERATION_INDEX_TABLES_SIMPLE
Case wdTOATemplate
FormatAsString = RID_STR_WORD_ENUMERATION_INDEX_TABLES_FROM_TEMPLATE
Case Else
FormatAsString = RID_STR_WORD_ENUMERATION_UNKNOWN
End Select
With myIssue
.IssueID = CID_INDEX_AND_REFERENCES
.IssueType = RID_STR_WORD_ISSUE_INDEX_AND_REFERENCES
.SubType = RID_STR_WORD_SUBISSUE_TABLE_OF_AUTHORITIES
.Location = .CLocationPage
.IssueTypeXML = CSTR_ISSUE_INDEX_AND_REFERENCES
.SubTypeXML = CSTR_SUBISSUE_TABLE_OF_AUTHORITIES
.locationXML = .CXMLLocationPage
.SubLocation = myRng.Information(wdActiveEndPageNumber)
.Attributes.Add RID_STR_WORD_ATTRIBUTE_LEADER
.Values.Add TabLeaderAsString
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_TOA_MIGRATE_AS_PLAIN_TEXT
mAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) = _
mAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
Set myRng = Nothing
Next
FinalExit:
Set myIssue = Nothing
Set myRng = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub Analyze_TOAField(myField As Field)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_TOAField"
Dim toa As TableOfAuthorities
Dim myIssue As IssueInfo
If myField.Type = wdFieldTOAEntry Then
Set myIssue = New IssueInfo
myField.Select
With myIssue
.IssueID = CID_FIELDS
.IssueType = RID_STR_WORD_ISSUE_FIELDS
.SubType = RID_STR_WORD_SUBISSUE_TABLE_OF_AUTHORITIES_FIELD
.Location = .CLocationPage
.IssueTypeXML = CSTR_ISSUE_FIELDS
.SubTypeXML = CSTR_SUBISSUE_TABLE_OF_AUTHORITIES_FIELD
.locationXML = .CXMLLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
.Attributes.Add RID_STR_WORD_ATTRIBUTE_FIELD_TEXT
.Values.Add myField.Code.Text
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_TOA_FIELD_LOST_ON_ROUNDTRIP
mAnalysis.IssuesCountArray(CID_FIELDS) = _
mAnalysis.IssuesCountArray(CID_FIELDS) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Sub Analyze_Tables_Borders(currDoc As Document)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_Tables_Borders"
Dim myIssue As IssueInfo
Set myIssue = New IssueInfo
Dim aTable As Table
Dim invalidBorders As String
For Each aTable In currDoc.Tables
invalidBorders = GetInvalidBorder(aTable)
If invalidBorders <> "" Then
aTable.Range.Select
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_TABLES
.IssueType = RID_STR_WORD_ISSUE_TABLES
.SubType = RID_STR_WORD_SUBISSUE_BORDER_STYLES
.Location = .CLocationPage
.IssueTypeXML = CSTR_ISSUE_TABLES
.SubTypeXML = CSTR_SUBISSUE_BORDER_STYLES
.locationXML = .CXMLLocationPage
.SubLocation = Selection.Information(wdActiveEndPageNumber)
.Line = Selection.Information(wdFirstCharacterLineNumber)
.column = Selection.Information(wdFirstCharacterColumnNumber)
.Attributes.Add RID_STR_WORD_ATTRIBUTE_BORDERS_NOT_DISPLAYING
.Values.Add invalidBorders
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_TABLE_BORDER
mAnalysis.IssuesCountArray(CID_TABLES) = mAnalysis.IssuesCountArray(CID_TABLES) + 1
End With
mAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
Next aTable
FinalExit:
Set myIssue = Nothing
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Resume FinalExit
End Sub
Function GetInvalidBorder(aTable As Table) As String
Dim theResult As String
theResult = ""
If IsInvalidBorderStyle(aTable.Borders(wdBorderTop).LineStyle) Then
theResult = theResult + "Top, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderBottom).LineStyle) Then
theResult = theResult + "Bottom, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderDiagonalDown).LineStyle) Then
theResult = theResult + "Down Diagonal, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderDiagonalUp).LineStyle) Then
theResult = theResult + "Up Diagonal, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderHorizontal).LineStyle) Then
theResult = theResult + "Horizontal, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderLeft).LineStyle) Then
theResult = theResult + "Left, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderRight).LineStyle) Then
theResult = theResult + "Right, "
End If
If IsInvalidBorderStyle(aTable.Borders(wdBorderVertical).LineStyle) Then
theResult = theResult + "Vertical, "
End If
If theResult <> "" Then
theResult = Left(theResult, (Len(theResult) - 2)) + "."
End If
GetInvalidBorder = theResult
End Function
Function IsInvalidBorderStyle(aStyle As WdLineStyle) As Boolean
Dim IsInvalid As Boolean
Select Case aStyle
Case wdLineStyleDot, wdLineStyleDashSmallGap, wdLineStyleDashLargeGap, wdLineStyleDashDot, _
wdLineStyleDashDotDot, wdLineStyleTriple, wdLineStyleThinThickThinSmallGap, wdLineStyleThinThickMedGap, _
wdLineStyleThickThinMedGap, wdLineStyleThinThickThinMedGap, wdLineStyleThinThickLargeGap, _
wdLineStyleThickThinLargeGap, wdLineStyleThinThickThinLargeGap, wdLineStyleSingleWavy, _
wdLineStyleDoubleWavy, wdLineStyleDashDotStroked, wdLineStyleEmboss3D, wdLineStyleEngrave3D
IsInvalid = True
Case Else
IsInvalid = False
End Select
IsInvalidBorderStyle = IsInvalid
End Function
Private Sub Class_Initialize()
Set mAnalysis = New DocumentAnalysis
End Sub
Private Sub Class_Terminate()
Set mAnalysis = Nothing
End Sub
Public Property Get Results() As DocumentAnalysis
Set Results = mAnalysis
End Property
Sub Analyze_NumberingTabs(currDoc As Document, docAnalysis As DocumentAnalysis)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_NumberingTabs"
Dim tb As TabStop
Dim customTabPos As Single
Dim tabs As Integer
Dim listLvl As Long
Dim tp As Single
Dim bHasAlignmentProblem As Boolean
Dim bHasTooManyTabs As Boolean
Dim myIssue As IssueInfo
Dim p As Object
bHasAlignmentProblem = False
bHasTooManyTabs = False
For Each p In currDoc.ListParagraphs
tabs = 0
For Each tb In p.TabStops
If tb.customTab Then
tabs = tabs + 1
customTabPos = tb.Position
End If
Next
If tabs = 1 Then
listLvl = p.Range.ListFormat.ListLevelNumber
tp = p.Range.ListFormat.ListTemplate.ListLevels.item(listLvl).TabPosition
If (p.Range.ListFormat.ListTemplate.ListLevels.item(listLvl).Alignment <> _
wdListLevelAlignLeft) Then
' ERROR: alignment problem
bHasAlignmentProblem = True
End If
If tp <> customTabPos Then
p.Range.InsertBefore ("XXXXX")
End If
'OK - at least heuristically
Else
'ERROR: too many tabs
bHasTooManyTabs = True
End If
Next
If (bHasAlignmentProblem) Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_INDEX_AND_REFERENCES
.IssueType = RID_STR_WORD_ISSUE_INDEX_AND_REFERENCES
.SubType = RID_STR_WORD_SUBISSUE_NUMBERING_TAB_ALIGNMENT
.Location = .CLocationDocument 'Location string
.IssueTypeXML = CSTR_ISSUE_INDEX_AND_REFERENCES
.SubTypeXML = CSTR_SUBISSUE_NUMBERING_TAB_ALIGNMENT
.locationXML = .CXMLLocationDocument
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_NUMBERING_TAB_ALIGNMENT
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) = _
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) + 1
End With
docAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
If (bHasTooManyTabs) Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_INDEX_AND_REFERENCES
.IssueType = RID_STR_WORD_ISSUE_INDEX_AND_REFERENCES
.SubType = RID_STR_WORD_SUBISSUE_NUMBERING_TAB_OVERFLOW
.Location = .CLocationDocument 'Location string
.IssueTypeXML = CSTR_ISSUE_INDEX_AND_REFERENCES
.SubTypeXML = CSTR_SUBISSUE_NUMBERING_TAB_OVERFLOW
.locationXML = .CXMLLocationDocument
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_NUMBERING_TAB_OVERFLOW
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) = _
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) + 1
End With
docAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
FinalExit:
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Set myIssue = Nothing
Resume FinalExit
End Sub
Sub Analyze_Numbering(currDoc As Document, docAnalysis As DocumentAnalysis)
On Error GoTo HandleErrors
Dim currentFunctionName As String
currentFunctionName = "Analyze_Numbering"
Dim myIssue As IssueInfo
Dim nFormatProblems As Integer
Dim nAlignmentProblems As Integer
nFormatProblems = 0
nAlignmentProblems = 0
Dim lt As ListTemplate
Dim lvl As ListLevel
Dim I, l_, p1, p2, v1, v2 As Integer
Dim display_levels As Integer
Dim fmt, prefix, postfix, res As String
For Each lt In currDoc.ListTemplates
l_ = 0
For Each lvl In lt.ListLevels
l_ = l_ + 1
'Selection.TypeText Text:="List Number Format " + lvl.NumberFormat
'Apply Heuristic
fmt = lvl.NumberFormat
p1 = InStr(fmt, "%")
p2 = InStrRev(fmt, "%")
v1 = val(Mid(fmt, p1 + 1, 1))
v2 = val(Mid(fmt, p2 + 1, 1))
display_levels = v2 - v1 + 1
prefix = Mid(fmt, 1, p1 - 1)
postfix = Mid(fmt, p2 + 2)
'Check Heuristic
res = prefix
For I = 2 To display_levels
res = "%" + Trim(Str(l_ - I + 1)) + "." + res
Next
res = res + "%" + Trim(Str(l_)) + postfix
If (StrComp(res, fmt) <> 0) Then
nFormatProblems = nFormatProblems + 1
'Selection.TypeText Text:="Label Problem: NumberFormat=" + fmt + " Heuristic=" + res
End If
'check alignment
If (lvl.NumberPosition <> wdListLevelAlignLeft) Then
nAlignmentProblems = nAlignmentProblems + 1
'Selection.TypeText Text:="Number alignment problem"
End If
Next
Next
If (nFormatProblems > 0) Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_INDEX_AND_REFERENCES
.IssueType = RID_STR_WORD_ISSUE_INDEX_AND_REFERENCES
.SubType = RID_STR_WORD_SUBISSUE_NUMBERING_FORMAT
.Location = .CLocationDocument 'Location string
.IssueTypeXML = CSTR_ISSUE_INDEX_AND_REFERENCES
.SubTypeXML = CSTR_SUBISSUE_NUMBERING_FORMAT
.locationXML = .CXMLLocationDocument
.Attributes.Add RID_STR_WORD_ATTRIBUTE_COUNT
.Values.Add nFormatProblems
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_NUMBERING_FORMAT
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) = _
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) + 1
End With
docAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
If (nAlignmentProblems > 0) Then
Set myIssue = New IssueInfo
With myIssue
.IssueID = CID_INDEX_AND_REFERENCES
.IssueType = RID_STR_WORD_ISSUE_INDEX_AND_REFERENCES
.SubType = RID_STR_WORD_SUBISSUE_NUMBERING_ALIGNMENT
.Location = .CLocationDocument 'Location string
.IssueTypeXML = CSTR_ISSUE_INDEX_AND_REFERENCES
.SubTypeXML = CSTR_SUBISSUE_NUMBERING_ALIGNMENT
.locationXML = .CXMLLocationDocument
.Attributes.Add RID_STR_WORD_ATTRIBUTE_COUNT
.Values.Add nAlignmentProblems
AddIssueDetailsNote myIssue, 0, RID_STR_WORD_NOTE_NUMBERING_ALIGNMENT
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) = _
docAnalysis.IssuesCountArray(CID_INDEX_AND_REFERENCES) + 1
End With
docAnalysis.Issues.Add myIssue
Set myIssue = Nothing
End If
FinalExit:
Exit Sub
HandleErrors:
WriteDebug currentFunctionName & " : " & mAnalysis.name & ": " & Err.Number & " " & Err.Description & " " & Err.Source
Set myIssue = Nothing
Resume FinalExit
End Sub
|