forked from rperdiga/MCPExtension
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMendix.StudioPro.ExtensionsAPI.xml
More file actions
2939 lines (2919 loc) · 216 KB
/
Mendix.StudioPro.ExtensionsAPI.xml
File metadata and controls
2939 lines (2919 loc) · 216 KB
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Mendix.StudioPro.ExtensionsAPI</name>
</assembly>
<members>
<member name="T:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob">
<summary>
It represents a collection of <see cref="T:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep"/> which will run in sequence.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob.#ctor(System.String)">
<summary>
Creates a new background job.
</summary>
<param name="title">The job title. Required to be a non-empty string.</param>
<exception cref="T:System.ArgumentNullException">When <paramref name="title"/> is <code>null</code> or an empty string.</exception>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob.Title">
<summary>
The title of the background job. It must be provided.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob.Steps">
<summary>
The steps of the job.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob.AddStep(System.String,System.String,System.Func{System.Boolean})">
<summary>
This method allows adding steps to a <see cref="T:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob"/>. It can be used like:
<code>
var job = new BackgroundJob("Background Job Title")
.AddStep("step one", "description one", () => true)
.AddStep("step two", "description two", () => true)
.AddStep("step three", "description three", () => true);
</code>
</summary>
<param name="title">The title of the step. It must be a non-empty string.</param>
<param name="description">The description of the step. It must be a non-empty string.</param>
<param name="function">The function of the step. It should return <code>true</code> when it was successful, and <code>false</code> when it failed. It must be provided.</param>
<exception cref="T:System.ArgumentNullException">When <paramref name="title"/> or <paramref name="description"/> is <code>null</code> or an empty , or when <paramref name="function"/> is <code>null</code>.</exception>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep">
<summary>
A step of a background job.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep.#ctor(System.String,System.String,System.Func{System.Boolean})">
<summary>
It allows to add a step to the <see cref="T:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJob"/> dialog.
</summary>
<param name="title">The title of the step. It must be a non-empty string.</param>
<param name="description">The description of the step. It must be a non-empty string.</param>
<param name="function">The function of the step. It should return <code>true</code> when it was successful, and <code>false</code> when it failed. It must be provided.</param>
<exception cref="T:System.ArgumentNullException">When <paramref name="title"/> or <paramref name="description"/> is <code>null</code> or an empty , or when <paramref name="function"/> is <code>null</code>.</exception>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep.Title">
<summary>
The title of the step.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep.Description">
<summary>
The description of the step.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.BackgroundJobs.BackgroundJobStep.Function">
<summary>
The function of the step.
</summary>
<returns>It returns true when successful or false when it failed.</returns>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1">
<summary>
Base class for an extension that introduces new <see href="https://docs.mendix.com/refguide/consistency-errors/">consistency errors (warnings)</see> for
specific model elements.
</summary>
<remarks>
Consistency check extensions are loaded in Studio Pro and MxBuild and hence must not use any gui-specific APIs, like <see cref="N:Mendix.StudioPro.ExtensionsAPI.UI"/>.
Note that the consistency check process can be interrupted and restarted at any point. It also can also be split across multiple threads, or multiple check
processes can be ran simultaneously (on the same or different threads). Avoid holding any state in your <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1"/>
implementation.
Extension must be marked with <see cref="T:System.ComponentModel.Composition.ExportAttribute"/> as <c>[Export(typeof(ConsistencyCheckExtension<>))]</c>, otherwise it will not be loaded.
</remarks>
<example>
You can implement extension as following:
<code>
[Export(typeof(ConsistencyCheckExtension<>))]
public class MyExtension : ConsistencyCheckExtension<IEntity>
{
public override IEnumerable<ConsistencyError> Check(IEntity entity, IModel model)
{
// returns any consistency errors for the entity
}
}
</code>
</example>
<typeparam name="TCheckedStructure">Type of the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure"/> to check.</typeparam>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1.Check(`0,Mendix.StudioPro.ExtensionsAPI.Model.IModel)">
<summary>
Should be overriden in a derived class to perform consistency checks for a <typeparamref name="TCheckedStructure">structure</typeparamref>.
</summary>
<remarks>
<see cref="M:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1.Check(`0,Mendix.StudioPro.ExtensionsAPI.Model.IModel)"/> is invoked after Studio Pro starts up or after the app structure has changed.
Studio Pro heavily optimizes the consistency check process by tracking what model elements <see cref="M:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1.Check(`0,Mendix.StudioPro.ExtensionsAPI.Model.IModel)"/> method accesses, and re-running it only
when these elements change. Hence it is adviced to access as few model elements as possible in one <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1"/>.
Note that multiple consistency check can be ran in parallel and that one consistency check can be ran over multiple threads. Do not make any assumptions
about order of execution of <see cref="M:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1.Check(`0,Mendix.StudioPro.ExtensionsAPI.Model.IModel)"/> and do not rely on state in <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1"/>.
</remarks>
<param name="structure">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure"/> to be checked for consistency by this method.</param>
<param name="model">Representation of the app model. Immutable.</param>
<returns>List of <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError"/> errors found in the <paramref name="structure"/>.</returns>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError">
<summary>
Represents consistency check errors in Studio Pro and MxBuild.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.#ctor(System.String,Mendix.StudioPro.ExtensionsAPI.Model.IStructure,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.Severity)">
<summary>
Construct new <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError"/>.
</summary>
<param name="message">The error message.</param>
<param name="errorSource">The specific structure causing the error.</param>
<param name="errorSourceDescription">
The description of the structure causing the error. Ignored for Core model structures, as description is inferred from <paramref name="errorSource"/>,
and hence can be left <c>null</c>.
</param>
<param name="errorSourceProperty">Description of <paramref name="errorSource"/>'s property causing the error, if any.</param>
<param name="severity">The severity of the failed check.</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.Message">
<summary>
The error message.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.ErrorSource">
<summary>
The specific element causing the error.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.ErrorSourceDescription">
<summary>
The description of the element causing the error. This property is ignored (so can be left <c>null</c>) if the source of the error is a Core model.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.ErrorSourceProperty">
<summary>
Description of <see cref="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.ErrorSource"/>'s property causing the error, if any.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyError.Severity">
<summary>
The severity of the failed check. Could be Error, Warning, or Deprecation. It defaults to Error.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Drawing.StudioProImage">
<summary>
Represents an image shown in the UI of Studio Pro.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Drawing.StudioProImage.#ctor(System.String)">
<summary>
Creates a Studio Pro image from a file.
</summary>
<param name="filename">The path to the file that contains the image.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Drawing.StudioProImage.#ctor(System.String,System.Reflection.Assembly)">
<summary>
Creates a Studio Pro image from a resource in an assembly (.dll file).
</summary>
<param name="resourcePath">The resource path in the assembly</param>
<param name="assembly">The <see cref="T:System.Reflection.Assembly"/> instance that contains the resource.</param>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.ExtensionBase">
<summary>
Base class for all extensions. Do not inherit from this class directly, but use concrete extension points like <see cref="T:Mendix.StudioPro.ExtensionsAPI.ConsistencyCheck.ConsistencyCheckExtension`1"/>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.ExtensionBase.Configuration">
<summary>
Current Studio Pro configuration.
</summary>
<remarks>
This property is not available until the extension has been fully constructed.
Use <see cref="T:Mendix.StudioPro.ExtensionsAPI.Services.IConfigurationService"/> if you need the configuration in the constructor of your extension.
</remarks>
<exception cref="T:System.InvalidOperationException">When trying to access this property in the constructor of the extensions.</exception>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.IConfiguration">
<summary>
Global Studio Pro configuration that can depend on environment or user-defined settings.
</summary>
<remarks>
Configuration can be accessed in any extension from <see cref="P:Mendix.StudioPro.ExtensionsAPI.ExtensionBase.Configuration"/>, or can be obtained by having <see cref="T:Mendix.StudioPro.ExtensionsAPI.Services.IConfigurationService"/> injected into your class.
</remarks>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.TargetServices">
<summary>
Versions of global services Studio Pro instance should use.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.Theme">
<summary>
User interface theme currently in use.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.MendixVersion">
<summary>
Version of Studio Pro in the semver v2 format <c>major.minor.patch</c>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.EarliestSupportedLegacyMendixVersion">
<summary>
Latest compatible version of Studio Pro in the semver v2 format <c>major.minor.patch</c>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.LatestSupportedLegacyMendixVersion">
<summary>
Latest compatible version of Studio Pro in the semver v2 format <c>major.minor.patch</c>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.BuildTag">
<summary>
Tag uniquely identifying Studio Pro build.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IConfiguration.CurrentLanguage">
<summary>
The current language for the UI of Studio Pro.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.ServicesEnvironment">
<summary>
Represents a versions of global services accessed by Studio Pro.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.ServicesEnvironment.None">
<summary>
Global services should not be used.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.ThemeSupport">
<summary>
Represents a user interface theme in Studio Pro.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.IHttpClient">
<summary>
Provides a class for sending HTTP requests and receiving HTTP responses from a resource identified by a URI.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.IHttpClient.Timeout">
<summary>
Gets or sets the timespan to wait before the request times out.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.IHttpClient.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
<summary>
Send an HTTP request as an asynchronous operation.
</summary>
<param name="request">The HTTP request message to send.</param>
<param name="cancellationToken">The cancellation token to cancel operation.</param>
<returns>Returns an http message asynchronously.</returns>
<exception cref="T:System.ArgumentNullException">The request is null.</exception>
<exception cref="T:System.InvalidOperationException">The request message was already sent by the HttpClient instance.</exception>
<exception cref="T:System.Net.Http.HttpRequestException">The request failed due to an underlying issue such as network connectivity, DNS failure, server certificate validation or timeout.</exception>
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The request failed due to timeout.</exception>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.BinaryType">
<summary>
Represents the Binary data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.BooleanType">
<summary>
Represents the Boolean data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType">
<summary>
Represents Mendix data types used in the app model and related places, such as microflow variables.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Binary">
<summary>
Gets a data type representing the Binary primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Boolean">
<summary>
Gets a data type representing the Boolean primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.DateTime">
<summary>
Gets a data type representing the DateTime primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Decimal">
<summary>
Gets a data type representing the Decimal primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Empty">
<summary>
Gets a data type representing the empty value.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Float">
<summary>
Gets a data type representing the Float primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Integer">
<summary>
Gets a data type representing the Integer primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.String">
<summary>
Gets a data type representing the String primitive data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Unknown">
<summary>
Gets a data type representing an unknown data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Void">
<summary>
Gets a data type representing the Void primitive data type.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Enumeration(Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName{Mendix.StudioPro.ExtensionsAPI.Model.Enumerations.IEnumeration})">
<summary>
Gets a data type representing a specific enumeration defined in an app model.
</summary>
<param name="enumeration">The qualified name of the enumeration</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.Object(Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName{Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity})">
<summary>
Gets a data type representing a single object of a specific entity defined in the app model.
</summary>
<param name="entity">The qualified name of the entity</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType.List(Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName{Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity})">
<summary>
Gets a data type representing a list of objects of a specific entity defined in the app model.
</summary>
<param name="entity">The qualified name of the entity</param>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DateTimeType">
<summary>
Represents the DateTime data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DecimalType">
<summary>
Represents the Decimal data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.EmptyType">
<summary>
Represents the empty value.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.EntityType">
<summary>
Base class for data types representing one or more instances of a certain entity.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.EntityType.EntityName">
<summary>
The entity referred to by this data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.EnumerationType">
<summary>
Represents an enumeration data type.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.EnumerationType.EnumerationName">
<summary>
The enumeration referred to by this data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.FloatType">
<summary>
Represents the Float data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.IntegerType">
<summary>
Represents the Integer data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.ListType">
<summary>
Represents a data type for a list of objects of a certain entity.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.ObjectType">
<summary>
Represents a data type for a single object of a certain entity.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.StringType">
<summary>
Represents the String data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.UnknownType">
<summary>
Represents an unknown data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.VoidType">
<summary>
Represents the Void data type.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions">
<summary>
This record represents the HxW dimensions of an object.
</summary>
<param name="Height">Height of an object.</param>
<param name="Width">Width of an object.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions.#ctor(System.Int32,System.Int32)">
<summary>
This record represents the HxW dimensions of an object.
</summary>
<param name="Height">Height of an object.</param>
<param name="Width">Width of an object.</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions.Height">
<summary>Height of an object.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions.Width">
<summary>Width of an object.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions.Empty">
<summary>
Create a <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Dimensions"/> object with a set of default dimensions.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection">
<summary>
It determines which type of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> should be returned when searching for them. If <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Parent"/>, only associations where the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity"/> requested is the parent will be returned. If <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Child"/>, only associations where the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity"/> requested is the child will be returned. Or any associations if <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Both"/> is used.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner">
<summary>
This property defines whether an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see> has one or two owners. If there is one owner, the owner is located at the start of the arrow.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner.Default">
<summary>
Only one entity is the owner (the parent).
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner.Both">
<summary>
Both entities are owners.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationType">
<summary>
This property defines whether an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see> is a reference (single) or a reference set (plural).
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationType.Reference">
<summary>
An object of the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner">owner</see> entity refers to zero or one objects of the other entity.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationType.ReferenceSet">
<summary>
An object of the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner">owner</see> entity refers to zero or more objects of the other entity.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior">
<summary>
The behavior which occurs when deleting one side of an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see>.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior.DeleteMeAndReferences">
<summary>
It will delete the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see> and its references.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior.DeleteMeButKeepReferences">
<summary>
It will delete the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see> and not its references.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior.DeleteMeIfNoReferences">
<summary>
It will delete the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation">association</see> if it had no references.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EntityAssociation">
<summary>
It represents an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> between two <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity"/> objects.
</summary>
<param name="Parent">The parent of the association.</param>
<param name="Child">The child of the association.</param>
<param name="Association">The association</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EntityAssociation.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity,Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity,Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation)">
<summary>
It represents an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> between two <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity"/> objects.
</summary>
<param name="Parent">The parent of the association.</param>
<param name="Child">The child of the association.</param>
<param name="Association">The association</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EntityAssociation.Parent">
<summary>The parent of the association.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EntityAssociation.Child">
<summary>The child of the association.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EntityAssociation.Association">
<summary>The association</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.EventType.RollBack">
<summary>
Rollback
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.Name">
<summary>
The name of the association is used to refer to it from forms, microflows, XPath constraints, etcetera.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.DataStorageGuid">
<summary>
Gets the Data Storage GUID of this entity. This is the GUID that identifies this entity in the Mendix Runtime database.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.Documentation">
<summary>
The documentation of the association.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.Owner">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationOwner">owner</see> of the association.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.Type">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationType">type</see> of the association.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.ParentDeleteBehavior">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior">behavior</see> which occurs when deleting the parent association.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation.ChildDeleteBehavior">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.DeletingBehavior">behavior</see> which occurs when deleting the child association.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute.DataStorageGuid">
<summary>
Gets the Data Storage GUID of this attribute. This is the GUID that identifies this attribute in the Mendix Runtime database.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity.DataStorageGuid">
<summary>
Gets the Data Storage GUID of this entity. This is the GUID that identifies this entity in the Mendix Runtime database.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity.AddAssociation(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity)">
<summary>
Create an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"></see> between this entity and another. This entity will be the parent.
</summary>
<param name="otherEntity">
The child entity of the association.
</param>
<returns>The new <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"></see> between this entity and the other entity.</returns>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity.DeleteAssociation(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation)">
<summary>
It deletes an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> from the entity.
</summary>
<param name="association">The association to remove.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity.GetAssociations(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection,Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity)">
<summary>
It returns a list of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> where this entity is either the child or parent.
</summary>
<param name="direction">It filters which associations should be returned. Either <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Parent"/>, <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Child"/> or <see cref="F:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.AssociationDirection.Both"/>.</param>
<param name="otherEntity">Optional entity on the other side of the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/>. If not supplied, any entity associated to this one will be used to find associations.</param>
<returns></returns>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IAbstractUnit">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#1-units">unit</see> in metamodel.
This is an abstract unit, so all instances of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IAbstractUnit"/> implement more concrete interface like <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Projects.IFolder"/>.
</summary>
<seealso href="https://apidocs.rnd.mendix.com/modelsdk/latest/classes/abstractunit.html"/>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.IAbstractUnit.Id">
<summary>
Unique identifier of the document. It does not change when a document is renamed or moved.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IElement">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#2-elements">element</see> in metamodel.
This is an abstract element, so all instances of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IElement"/> also implement more concrete interface like <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflow"/>.
</summary>
<seealso href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/projects-metamodel#2-elements"/>
<seealso href="https://apidocs.rnd.mendix.com/modelsdk/latest/classes/element.html"/>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IModel">
<summary>
Representation of Mendix app loaded in Studio Pro in terms of <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel">Mendix Metamodel</see>.
</summary>
<remarks>
Interfaces used to expose an app in Studio Pro are aligned with the interfaces of <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/">Mendix Platform SDK</see>,
so it can be handy to have its <see href="https://apidocs.rnd.mendix.com/modelsdk/latest/index.html">reference documentation</see> on hand.
</remarks>
<seealso href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/"/>
<seealso href="https://apidocs.rnd.mendix.com/modelsdk/latest/classes/model.html"/>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.IModel.Root">
<summary>
Returns the app's model content.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.Create``1">
<summary>
Create a new model <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure">structure</see>.
</summary>
<typeparam name="T">Type of the structure to create. Abstract units and abstract elements are not supported.</typeparam>
<returns>Create a new model <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure">structure</see>.</returns>
<exception cref="T:System.ArgumentException"><typeparamref name="T"/> is not a type from <see cref="N:Mendix.StudioPro.ExtensionsAPI"/> assembly.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><typeparamref name="T"/> can not be created, for example because it is abstract.</exception>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.Copy``1(``0)">
<summary>
Create a model <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure">structure</see> by deep copying the given <paramref name="source"/>.
</summary>
<typeparam name="T">Type of the structure to copy.</typeparam>
<returns>Copy of the <paramref name="source"/>. It is not attached to a model.</returns>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.ToQualifiedName``1(System.String)">
<summary>
Create an object reference from its string representation.
</summary>
<remarks>
Note, that this method returns a value even when the object reference is invalid. That is when no object of type <typeparamref name="T"/> exists in the
app with the QualifiedName matching <paramref name="fullName"/>. In that case <see cref="M:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1.Resolve"/> of the result would return
<c>null</c>.
</remarks>
<param name="fullName">String representation of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1"/>.</param>
<typeparam name="T">Type of object referenced by <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1"/>.</typeparam>
<returns>
Created <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1"/> which <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName.FullName"/> equals <paramref name="fullName"/>. Note, that the reference might
be invalid, and hence its <see cref="M:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1.Resolve"/> method might return <c>null</c>.
</returns>
<exception cref="T:System.ArgumentException"><typeparamref name="T"/> is not a type from <see cref="N:Mendix.StudioPro.ExtensionsAPI"/> assembly.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><typeparamref name="T"/> cannot be referenced.</exception>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.TryGetAbstractUnitById(System.String,Mendix.StudioPro.ExtensionsAPI.Model.IAbstractUnit@)">
<summary>
Get an IAbstractUnit by its unique identifier.
</summary>
<param name="abstractUnitId">
Unique identifier of the abstractUnit
</param>
<param name="abstractUnit">
Contains the retrieved IAbstractUnit if it is found, otherwise null.
</param>
<returns>True if the abstractUnit was retrieved, false if the abstractUnit could not be found.</returns>
<exception cref="T:System.ArgumentException"><paramref name="abstractUnitId"/> is null or empty or invalid.</exception>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.StartTransaction(System.String)">
<summary>
Starts a transaction which wraps model changes.
</summary>
<param name="description">
Description of the operation performed on the model. This description is visible to Studio Pro user in Edit -> Undo menu.
</param>
<returns><see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction"/> representing the transaction.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="description"/> is null or empty.</exception>
<exception cref="T:System.InvalidOperationException">Another transaction is already running.</exception>
<remarks>
Any modification to the model must be done within a transaction otherwise a <see cref="T:System.InvalidOperationException"/> is thrown. There can be only a
single active (i.e. not committed or rolled back) <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction"/> for the whole app.
Transactions do not isolate changes, but group them. Thus, any change to a model is immediately visible to all code working
with the model. When a transaction is rolled back, all changes are reverted.
</remarks>
<example>
Please see the following example showing a way to modify the StudioPro model structure in a transaction:
<code>
using (var transaction = model.StartTransaction("rename folder"))
{
folder.Name = "New_Name";
transaction.Commit();
}
</code>
</example>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1">
<summary>
Represents a <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#3-1-references">by-name reference</see> to an object
(element or unit) or type <typeparamref name="T"/> in metamodel. The reference can be resolved to retrieve the object it is referencing.
</summary>
<remarks>
Apps can contain invalid references, for example references to objects removed from the app. Such references are called invalid and they cannot
be resolved even if an object they point to still exists in Studio Pro's memory.
</remarks>
<typeparam name="T">Type of the referenced object.</typeparam>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName`1.Resolve">
<summary>
Retrieve the referenced object.
</summary>
<returns>The referenced object, if reference is valid. Null otherwise.</returns>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName">
<summary>
Represents a <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#3-1-references">by-name reference</see> to an object
(element or unit) in metamodel. The type of the referenced object is not statically known.
</summary>
<remarks>
Apps can contain invalid references, for example references to objects removed from the app. Such references are called invalid and they cannot
be resolved even if an object they point to still exists in Studio Pro's memory.
</remarks>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName.Name">
<summary>
Name of the referenced object. For example <c>MyHomePage</c>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName.FullName">
<summary>
Fully qualified name of the referenced object. For example <c>MyFirstModule.MyHomePage</c>.
</summary>
<remarks><see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.IQualifiedName.FullName"/> is globally unique.</remarks>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IReferableStructure">
<summary>
Represents any model object that is referable by-name, i.e. where the concrete type has a <code>QualifiedName</code> property, such as <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Constants.IConstant"/> and <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IEntity"/>.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.IStructure">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#1-units">unit</see> or <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/understanding-the-metamodel#2-elements">element</see> in metamodel.
All instances of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IAbstractUnit"/> and <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.IElement"/> implement this interface.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction">
<summary>
Transaction grouping the changes in the app model.
</summary>
<remarks>
Transactions provide a way to group changes together and to give a user-friendly name for these changes (visible in Edit -> Undo menu). Transactions
must be committed or rolled back where the latter one can be achieved by explicitly calling <see cref="M:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction.Rollback"/> or by implicit call to
<see cref="M:System.IDisposable.Dispose"/> e.g. due to an exception being thrown. Committed transaction can later be reverted by a user using undo.
Changes done within a transaction are not isolated, that is other parts of Studio Pro code, including editors, react to them even before
<see cref="M:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction.Commit"/> is called. It is not recommended to have transactions active while a user can interact with Studio Pro screens different from the
one you control.
</remarks>
<example>
Transactions can be created using <see cref="M:Mendix.StudioPro.ExtensionsAPI.Model.IModel.StartTransaction(System.String)"/>.
</example>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction.Commit">
<summary>
Commit the transaction. That indicates that an atomic set of changes is completed and: saves all affected documents that are not currently being
edited by a user; adds an undo item for the documents that are edited.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.ITransaction.Rollback">
<summary>
Roll back the transaction. That is, undo all changes done during it.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Location">
<summary>
This record represents a set of two-dimensional coordinates.
</summary>
<param name="X">X axis coordinate.</param>
<param name="Y">Y axis coordinate.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Location.#ctor(System.Int32,System.Int32)">
<summary>
This record represents a set of two-dimensional coordinates.
</summary>
<param name="X">X axis coordinate.</param>
<param name="Y">Y axis coordinate.</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Location.X">
<summary>X axis coordinate.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Location.Y">
<summary>Y axis coordinate.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Location.Empty">
<summary>
Create a <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Location"/> object with a set of default coordinates.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression">
<summary>
Represents a microflow expression like "$employee/Name".
</summary>
<remarks>
This type is read-only. To create new <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/> use <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowExpressionService.CreateFromString(System.String)"/>.
</remarks>
<see href="https://docs.mendix.com/studio/expressions"/>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression.Text">
<summary>
Returns the string representation of the expression.
</summary>
</member>
<member name="F:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.Actions.CommitEnum.YesWithoutEvents">
<summary>
Yes without events
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction">
<summary>
This allows to create a function for an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IAggregateListAction"/>.
It can have different behaviors. It can use an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/> to generate its result,
or it can use an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> to do so. Or it can instead be an aggregate list that performs a <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.ReduceListFunction"/> on the list.
All of these parameters are optional. For more information see the official Studio Pro documentation at https://docs.mendix.com/refguide/aggregate-list.
To create this function for different scenarios, you can use the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService"/> service. It provides a series of methods to easily create different activities.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.#ctor">
<summary>
It is recommended to use the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateAggregateListActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.Microflows.Actions.AggregateFunctionEnum)"/> method to easily create an activity that uses this function.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression)">
<summary>
It is recommended to use the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateAggregateListByExpressionActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.Microflows.Actions.AggregateFunctionEnum)"/> method to easily create an activity that uses this function.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute)">
<summary>
It is recommended to use the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateAggregateListByAttributeActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.Microflows.Actions.AggregateFunctionEnum)"/> method to easily create an activity that uses this function.
</summary>
<param name="attribute">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> used in the fuction.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,Mendix.StudioPro.ExtensionsAPI.Model.Microflows.ReduceListFunction)">
<summary>
It is recommended to use the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateAggregateListByExpressionActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.Microflows.Actions.AggregateFunctionEnum)"/> method to easily create an activity that uses this function.
</summary>
<param name="expression">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/>> used in the fuction.</param>
<param name="reduceListType">The function that is only used to perform a reduce operation on the list.</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.Expression">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/> used to perform the aggregate operation. If provided, the <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.Attribute"/> should not be provided as well.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.Attribute">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> used to perform the aggregate operation. If provided, the <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.Expression"/> should not be provided as well.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.ReduceListFunction">
<summary>
The <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AggregateListFunction.ReduceListFunction"/> used to only perform a reduce operation on the list. It is recommended using the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateReduceAggregateActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType)"/> to have an easy way to create that type of activity.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.ReduceListFunction.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression)">
<summary>
This function is used by a <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IAggregateListFunction"/> to perform a reduce operation on a list. For more information see the official Studio Pro documentation at https://docs.mendix.com/refguide/aggregate-list.
It is recommended to use the <see cref="M:Mendix.StudioPro.ExtensionsAPI.Services.IMicroflowActivitiesService.CreateReduceAggregateActivity(Mendix.StudioPro.ExtensionsAPI.Model.IModel,System.String,System.String,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression,Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType)"/> method to easily create an activity that uses this function.
</summary>
<param name="dataType">The data type that gets returned.</param>
<param name="initialValueExpression">The initial value of the list, which is compared against the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/> from the <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IAggregateListFunction.Expression"/></param>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeSorting">
<summary>
When creating or filtering lists through an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> we can choose a few <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> to sort it by.
</summary>
<param name="Attribute">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> whose value will be used to sort by.</param>
<param name="SortByDescending">It can be true or false.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeSorting.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute,System.Boolean)">
<summary>
When creating or filtering lists through an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> we can choose a few <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> to sort it by.
</summary>
<param name="Attribute">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> whose value will be used to sort by.</param>
<param name="SortByDescending">It can be true or false.</param>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeSorting.Attribute">
<summary>The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/> whose value will be used to sort by.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeSorting.SortByDescending">
<summary>It can be true or false.</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMemberChange.MemberType">
<summary>
The type of change. It can either be an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AssociationMemberChangeType"/> or <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeMemberChangeType"/>.
</summary>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMemberChange.Value">
<summary>
The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.MicroflowExpressions.IMicroflowExpression"/> that represents the new value of the object.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMemberChangeType">
<summary>
Some <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> perform changes that can be applied to an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> or an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/>.
Use <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AssociationMemberChangeType"/> for an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/> or use <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeMemberChangeType"/> for an attribute.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AssociationMemberChangeType">
<summary>
Used to tell the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> that the change should apply to the an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/>.
</summary>
<param name="association">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/>.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AssociationMemberChangeType.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation)">
<summary>
Used to tell the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> that the change should apply to the an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/>.
</summary>
<param name="association">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAssociation"/>.</param>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeMemberChangeType">
<summary>
Used to tell the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> that the change should apply to the an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/>.
</summary>
<param name="attribute">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/>.</param>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.AttributeMemberChangeType.#ctor(Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute)">
<summary>
Used to tell the <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IActionActivity"/> that the change should apply to the an <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/>.
</summary>
<param name="attribute">The <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.DomainModels.IAttribute"/>.</param>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflow">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/microflows-metamodel">microflow</see> in a metamodel.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflowAction.CalculateScopeVariables">
<summary>
Processes model changes and retrieves available scope variables for this Microflow Action
</summary>
<returns>a List of Scope Variables accessible by this Microflow Action</returns>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflowAction.CreateExpressionContext(Mendix.StudioPro.ExtensionsAPI.Model.DataTypes.DataType[])">
<summary>
Creates the expression context of this microflow action.
</summary>
</member>
<member name="M:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflowAction.GetMicroflow">
<summary>
It returns the microflow container of this action.
</summary>
<returns>The containing <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflow"/>.</returns>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflowExpressionContext">
<summary>
The expression context of a microflow action.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Pages.IPage">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/pages-metamodel/">page</see> in the app model.
</summary>
</member>
<member name="T:Mendix.StudioPro.ExtensionsAPI.Model.Projects.IDocument">
<summary>
Representation of a single <see href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/projects-metamodel#2-2-documents">document</see> in metamodel.
This is an abstract unit, so all instances of <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Projects.IDocument"/> also implement more concrete interface like <see cref="T:Mendix.StudioPro.ExtensionsAPI.Model.Microflows.IMicroflow"/>.
</summary>
<remarks>Note that a document can be marked as <see cref="P:Mendix.StudioPro.ExtensionsAPI.Model.Projects.IDocument.Excluded"/>. Such documents should be ignored for the majority of operations.</remarks>
<seealso href="https://docs.mendix.com/apidocs-mxsdk/mxsdk/projects-metamodel#2-2-documents"/>
<seealso href="https://apidocs.rnd.mendix.com/modelsdk/latest/classes/projects.document.html"/>
</member>
<member name="P:Mendix.StudioPro.ExtensionsAPI.Model.Projects.IDocument.Name">
<summary>
Name of the document.
</summary>
<remarks>Note that changing a name of the document renames it. That is, all by-name reference to that document are updated.</remarks>
<exception cref="T:System.ArgumentException">New value is not valid for this document type or is not unique.</exception>