Class GroupAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

This class implements APIs for Group.

public static class GroupAPI

Inheritance

object ← GroupAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

ApplyGroup(Obj, IEnumerable<Obj>)

Apply a update.

[NotNull(new string[] { "group" })]
public static void ApplyGroup(this Obj group, IEnumerable<Obj> objs)

Parameters

group Obj

The target to apply update.

objs IEnumerable<Obj>

The collection of objects.

Exceptions

ArgumentNullException

Will be thrown if 'group' is null.

ArgumentException

Will be thrown if the type of 'group' is not .

CreateGroup(SubSystemDocument, IEnumerable<Obj>)

Create

[NotNull(new string[] { "subSystemDocument", "objs" })]
public static Obj CreateGroup(this SubSystemDocument subSystemDocument, IEnumerable<Obj> objs)

Parameters

subSystemDocument SubSystemDocument

The to create a group.

objs IEnumerable<Obj>

The bodies of a group.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'subSystemDocument', 'objs' is null.

ArgumentException

Will be thrown if the type of 'objs' is not .